sys/ximage/ximagesink.c

   1 /* GStreamer
   2  * Copyright (C) <2005> Julien Moutte <julien@moutte.net>
   3  *
   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.
   8  *
   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.
  13  *
  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.
  18  */
  19
  20 /**
  21  * SECTION:element-ximagesink
  22  *
  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.
  28  *
  29  * <refsect2>
  30  * <title>Scaling</title>
  31  * <para>
  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.
  43  * </para>
  44  * </refsect2>
  45  * <refsect2>
  46  * <title>Events</title>
  47  * <para>
  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.
  57  * </para>
  58  * </refsect2>
  59  * <refsect2>
  60  * <title>Pixel aspect ratio</title>
  61  * <para>
  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.
  72  * </para>
  73  * </refsect2>
  74  * <refsect2>
  75  * <title>Examples</title>
  76  * |[
  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.
  83  * |[
  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.)
  91  * |[
  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\)'.
  99  * </refsect2>
 100  */
 101
 102 #ifdef HAVE_CONFIG_H
 103 #include "config.h"
 104 #endif
 105
 106 /* Our interfaces */
 107 #include <gst/video/navigation.h>
 108 #include <gst/video/videooverlay.h>
 109
 110 #include <gst/video/gstvideometa.h>
 111
 112 /* Object header */
 113 #include "ximagesink.h"
 114
 115 /* Debugging category */
 116 #include <gst/gstinfo.h>
 117
 118 /* for XkbKeycodeToKeysym */
 119 #include <X11/XKBlib.h>
 120
 121 GST_DEBUG_CATEGORY_EXTERN (gst_debug_ximagesink);
 122 GST_DEBUG_CATEGORY_EXTERN (GST_CAT_PERFORMANCE);
 123 #define GST_CAT_DEFAULT gst_debug_ximagesink
 124
 125 typedef struct
 126 {
 127   unsigned long flags;
 128   unsigned long functions;
 129   unsigned long decorations;
 130   long input_mode;
 131   unsigned long status;
 132 }
 133 MotifWmHints, MwmHints;
 134
 135 #define MWM_HINTS_DECORATIONS   (1L << 1)
 136
 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);
 140
 141 static GstStaticPadTemplate gst_ximagesink_sink_template_factory =
 142 GST_STATIC_PAD_TEMPLATE ("sink",
 143     GST_PAD_SINK,
 144     GST_PAD_ALWAYS,
 145     GST_STATIC_CAPS ("video/x-raw, "
 146         "framerate = (fraction) [ 0, MAX ], "
 147         "width = (int) [ 1, MAX ], " "height = (int) [ 1, MAX ]")
 148     );
 149
 150 enum
 151 {
 152   PROP_0,
 153   PROP_DISPLAY,
 154   PROP_SYNCHRONOUS,
 155   PROP_PIXEL_ASPECT_RATIO,
 156   PROP_FORCE_ASPECT_RATIO,
 157   PROP_HANDLE_EVENTS,
 158   PROP_HANDLE_EXPOSE,
 159   PROP_WINDOW_WIDTH,
 160   PROP_WINDOW_HEIGHT
 161 };
 162
 163 /* ============================================================= */
 164 /*                                                               */
 165 /*                       Public Methods                          */
 166 /*                                                               */
 167 /* ============================================================= */
 168
 169 /* =========================================== */
 170 /*                                             */
 171 /*          Object typing & Creation           */
 172 /*                                             */
 173 /* =========================================== */
 174 static void gst_ximagesink_navigation_init (GstNavigationInterface * iface);
 175 static void gst_ximagesink_video_overlay_init (GstVideoOverlayInterface *
 176     iface);
 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));
 182
 183 /* ============================================================= */
 184 /*                                                               */
 185 /*                       Private Methods                         */
 186 /*                                                               */
 187 /* ============================================================= */
 188
 189 /* X11 stuff */
 190
 191 /* We are called with the x_lock taken */
 192 static void
 193 gst_ximagesink_xwindow_draw_borders (GstXImageSink * ximagesink,
 194     GstXWindow * xwindow, GstVideoRectangle rect)
 195 {
 196   g_return_if_fail (GST_IS_XIMAGESINK (ximagesink));
 197   g_return_if_fail (xwindow != NULL);
 198
 199   XSetForeground (ximagesink->xcontext->disp, xwindow->gc,
 200       ximagesink->xcontext->black);
 201
 202   /* Left border */
 203   if (rect.x > 0) {
 204     XFillRectangle (ximagesink->xcontext->disp, xwindow->win, xwindow->gc,
 205         0, 0, rect.x, xwindow->height);
 206   }
 207
 208   /* Right border */
 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);
 212   }
 213
 214   /* Top border */
 215   if (rect.y > 0) {
 216     XFillRectangle (ximagesink->xcontext->disp, xwindow->win, xwindow->gc,
 217         0, 0, xwindow->width, rect.y);
 218   }
 219
 220   /* Bottom border */
 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);
 224   }
 225 }
 226
 227 /* This function puts a GstXImageBuffer on a GstXImageSink's window */
 228 static gboolean
 229 gst_ximagesink_ximage_put (GstXImageSink * ximagesink, GstBuffer * ximage)
 230 {
 231   GstXImageMeta *meta;
 232   GstVideoCropMeta *crop;
 233   GstVideoRectangle src, dst, result;
 234   gboolean draw_border = FALSE;
 235
 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);
 239
 240   if (G_UNLIKELY (ximagesink->xwindow == NULL)) {
 241     g_mutex_unlock (&ximagesink->flow_lock);
 242     return FALSE;
 243   }
 244
 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) {
 248     draw_border = TRUE;
 249   }
 250
 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);
 256     }
 257     GST_LOG_OBJECT (ximagesink, "reffing %p as our current image", ximage);
 258     ximagesink->cur_image = gst_buffer_ref (ximage);
 259   }
 260
 261   /* Expose sends a NULL image, we take the latest frame */
 262   if (!ximage) {
 263     draw_border = TRUE;
 264     if (ximagesink->cur_image) {
 265       ximage = ximagesink->cur_image;
 266     } else {
 267       g_mutex_unlock (&ximagesink->flow_lock);
 268       return TRUE;
 269     }
 270   }
 271
 272   meta = gst_buffer_get_ximage_meta (ximage);
 273   crop = gst_buffer_get_video_crop_meta (ximage);
 274
 275   if (crop) {
 276     src.x = crop->x + meta->x;
 277     src.y = crop->y + meta->y;
 278     src.w = crop->width;
 279     src.h = crop->height;
 280     GST_LOG_OBJECT (ximagesink,
 281         "crop %dx%d-%dx%d", crop->x, crop->y, crop->width, crop->height);
 282   } else {
 283     src.x = meta->x;
 284     src.y = meta->y;
 285     src.w = meta->width;
 286     src.h = meta->height;
 287   }
 288   dst.w = ximagesink->xwindow->width;
 289   dst.h = ximagesink->xwindow->height;
 290
 291   gst_video_sink_center_rect (src, dst, &result, FALSE);
 292
 293   g_mutex_lock (&ximagesink->x_lock);
 294
 295   if (draw_border) {
 296     gst_ximagesink_xwindow_draw_borders (ximagesink, ximagesink->xwindow,
 297         result);
 298     ximagesink->draw_border = FALSE;
 299   }
 300 #ifdef HAVE_XSHM
 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, meta->ximage, src.x, src.y, result.x, result.y,
 308         result.w, result.h, FALSE);
 309   } else
 310 #endif /* HAVE_XSHM */
 311   {
 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, meta->ximage, src.x, src.y, result.x, result.y,
 318         result.w, result.h);
 319   }
 320
 321   XSync (ximagesink->xcontext->disp, FALSE);
 322
 323   g_mutex_unlock (&ximagesink->x_lock);
 324
 325   g_mutex_unlock (&ximagesink->flow_lock);
 326
 327   return TRUE;
 328 }
 329
 330 static gboolean
 331 gst_ximagesink_xwindow_decorate (GstXImageSink * ximagesink,
 332     GstXWindow * window)
 333 {
 334   Atom hints_atom = None;
 335   MotifWmHints *hints;
 336
 337   g_return_val_if_fail (GST_IS_XIMAGESINK (ximagesink), FALSE);
 338   g_return_val_if_fail (window != NULL, FALSE);
 339
 340   g_mutex_lock (&ximagesink->x_lock);
 341
 342   hints_atom = XInternAtom (ximagesink->xcontext->disp, "_MOTIF_WM_HINTS",
 343       True);
 344   if (hints_atom == None) {
 345     g_mutex_unlock (&ximagesink->x_lock);
 346     return FALSE;
 347   }
 348
 349   hints = g_malloc0 (sizeof (MotifWmHints));
 350
 351   hints->flags |= MWM_HINTS_DECORATIONS;
 352   hints->decorations = 1 << 0;
 353
 354   XChangeProperty (ximagesink->xcontext->disp, window->win,
 355       hints_atom, hints_atom, 32, PropModeReplace,
 356       (guchar *) hints, sizeof (MotifWmHints) / sizeof (long));
 357
 358   XSync (ximagesink->xcontext->disp, FALSE);
 359
 360   g_mutex_unlock (&ximagesink->x_lock);
 361
 362   g_free (hints);
 363
 364   return TRUE;
 365 }
 366
 367 static void
 368 gst_ximagesink_xwindow_set_title (GstXImageSink * ximagesink,
 369     GstXWindow * xwindow, const gchar * media_title)
 370 {
 371   if (media_title) {
 372     g_free (ximagesink->media_title);
 373     ximagesink->media_title = g_strdup (media_title);
 374   }
 375   if (xwindow) {
 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;
 382
 383       /* set application name as a title */
 384       app_name = g_get_application_name ();
 385
 386       if (app_name && ximagesink->media_title) {
 387         title = title_mem = g_strconcat (ximagesink->media_title, " : ",
 388             app_name, NULL);
 389       } else if (app_name) {
 390         title = app_name;
 391       } else if (ximagesink->media_title) {
 392         title = ximagesink->media_title;
 393       }
 394
 395       if (title) {
 396         if ((XStringListToTextProperty (((char **) &title), 1,
 397                     &xproperty)) != 0) {
 398           XSetWMName (ximagesink->xcontext->disp, xwindow->win, &xproperty);
 399           XFree (xproperty.value);
 400         }
 401
 402         g_free (title_mem);
 403       }
 404     }
 405   }
 406 }
 407
 408 /* This function handles a GstXWindow creation */
 409 static GstXWindow *
 410 gst_ximagesink_xwindow_new (GstXImageSink * ximagesink, gint width, gint height)
 411 {
 412   GstXWindow *xwindow = NULL;
 413   XGCValues values;
 414
 415   g_return_val_if_fail (GST_IS_XIMAGESINK (ximagesink), NULL);
 416
 417   xwindow = g_new0 (GstXWindow, 1);
 418
 419   xwindow->width = width;
 420   xwindow->height = height;
 421   xwindow->internal = TRUE;
 422
 423   g_mutex_lock (&ximagesink->x_lock);
 424
 425   xwindow->win = XCreateSimpleWindow (ximagesink->xcontext->disp,
 426       ximagesink->xcontext->root,
 427       0, 0, width, height, 0, 0, ximagesink->xcontext->black);
 428
 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);
 432
 433   /* set application name as a title */
 434   gst_ximagesink_xwindow_set_title (ximagesink, xwindow, NULL);
 435
 436   if (ximagesink->handle_events) {
 437     Atom wm_delete;
 438
 439     XSelectInput (ximagesink->xcontext->disp, xwindow->win, ExposureMask |
 440         StructureNotifyMask | PointerMotionMask | KeyPressMask |
 441         KeyReleaseMask | ButtonPressMask | ButtonReleaseMask);
 442
 443     /* Tell the window manager we'd like delete client messages instead of
 444      * being killed */
 445     wm_delete = XInternAtom (ximagesink->xcontext->disp,
 446         "WM_DELETE_WINDOW", False);
 447     (void) XSetWMProtocols (ximagesink->xcontext->disp, xwindow->win,
 448         &wm_delete, 1);
 449   }
 450
 451   xwindow->gc = XCreateGC (ximagesink->xcontext->disp, xwindow->win,
 452       0, &values);
 453
 454   XMapRaised (ximagesink->xcontext->disp, xwindow->win);
 455
 456   XSync (ximagesink->xcontext->disp, FALSE);
 457
 458   g_mutex_unlock (&ximagesink->x_lock);
 459
 460   gst_ximagesink_xwindow_decorate (ximagesink, xwindow);
 461
 462   gst_video_overlay_got_window_handle (GST_VIDEO_OVERLAY (ximagesink),
 463       xwindow->win);
 464
 465   return xwindow;
 466 }
 467
 468 /* This function destroys a GstXWindow */
 469 static void
 470 gst_ximagesink_xwindow_destroy (GstXImageSink * ximagesink,
 471     GstXWindow * xwindow)
 472 {
 473   g_return_if_fail (xwindow != NULL);
 474   g_return_if_fail (GST_IS_XIMAGESINK (ximagesink));
 475
 476   g_mutex_lock (&ximagesink->x_lock);
 477
 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);
 481   else
 482     XSelectInput (ximagesink->xcontext->disp, xwindow->win, 0);
 483
 484   XFreeGC (ximagesink->xcontext->disp, xwindow->gc);
 485
 486   XSync (ximagesink->xcontext->disp, FALSE);
 487
 488   g_mutex_unlock (&ximagesink->x_lock);
 489
 490   g_free (xwindow);
 491 }
 492
 493 static void
 494 gst_ximagesink_xwindow_update_geometry (GstXImageSink * ximagesink)
 495 {
 496   XWindowAttributes attr;
 497   gboolean reconfigure;
 498
 499   g_return_if_fail (GST_IS_XIMAGESINK (ximagesink));
 500
 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);
 505     return;
 506   }
 507
 508   XGetWindowAttributes (ximagesink->xcontext->disp,
 509       ximagesink->xwindow->win, &attr);
 510
 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;
 516
 517   g_mutex_unlock (&ximagesink->x_lock);
 518
 519   if (reconfigure)
 520     gst_pad_push_event (GST_BASE_SINK (ximagesink)->sinkpad,
 521         gst_event_new_reconfigure ());
 522 }
 523
 524 static void
 525 gst_ximagesink_xwindow_clear (GstXImageSink * ximagesink, GstXWindow * xwindow)
 526 {
 527   g_return_if_fail (xwindow != NULL);
 528   g_return_if_fail (GST_IS_XIMAGESINK (ximagesink));
 529
 530   g_mutex_lock (&ximagesink->x_lock);
 531
 532   XSetForeground (ximagesink->xcontext->disp, xwindow->gc,
 533       ximagesink->xcontext->black);
 534
 535   XFillRectangle (ximagesink->xcontext->disp, xwindow->win, xwindow->gc,
 536       0, 0, xwindow->width, xwindow->height);
 537
 538   XSync (ximagesink->xcontext->disp, FALSE);
 539
 540   g_mutex_unlock (&ximagesink->x_lock);
 541 }
 542
 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
 545    and navigation.*/
 546 static void
 547 gst_ximagesink_handle_xevents (GstXImageSink * ximagesink)
 548 {
 549   XEvent e;
 550   guint pointer_x = 0, pointer_y = 0;
 551   gboolean pointer_moved = FALSE;
 552   gboolean exposed = FALSE, configured = FALSE;
 553
 554   g_return_if_fail (GST_IS_XIMAGESINK (ximagesink));
 555
 556   /* Then we get all pointer motion events, only the last position is
 557      interesting. */
 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);
 564
 565     switch (e.type) {
 566       case MotionNotify:
 567         pointer_x = e.xmotion.x;
 568         pointer_y = e.xmotion.y;
 569         pointer_moved = TRUE;
 570         break;
 571       default:
 572         break;
 573     }
 574     g_mutex_lock (&ximagesink->flow_lock);
 575     g_mutex_lock (&ximagesink->x_lock);
 576   }
 577
 578   if (pointer_moved) {
 579     g_mutex_unlock (&ximagesink->x_lock);
 580     g_mutex_unlock (&ximagesink->flow_lock);
 581
 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);
 586
 587     g_mutex_lock (&ximagesink->flow_lock);
 588     g_mutex_lock (&ximagesink->x_lock);
 589   }
 590
 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)) {
 596     KeySym keysym;
 597     const char *key_str = NULL;
 598
 599     /* We lock only for the X function call */
 600     g_mutex_unlock (&ximagesink->x_lock);
 601     g_mutex_unlock (&ximagesink->flow_lock);
 602
 603     switch (e.type) {
 604       case ButtonPress:
 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);
 611         break;
 612       case ButtonRelease:
 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);
 617         break;
 618       case KeyPress:
 619       case KeyRelease:
 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);
 627         } else {
 628           key_str = "unknown";
 629         }
 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);
 636         break;
 637       default:
 638         GST_DEBUG_OBJECT (ximagesink, "ximagesink unhandled X event (%d)",
 639             e.type);
 640     }
 641     g_mutex_lock (&ximagesink->flow_lock);
 642     g_mutex_lock (&ximagesink->x_lock);
 643   }
 644
 645   /* Handle Expose */
 646   while (XCheckWindowEvent (ximagesink->xcontext->disp,
 647           ximagesink->xwindow->win, ExposureMask | StructureNotifyMask, &e)) {
 648     switch (e.type) {
 649       case Expose:
 650         exposed = TRUE;
 651         break;
 652       case ConfigureNotify:
 653         g_mutex_unlock (&ximagesink->x_lock);
 654         gst_ximagesink_xwindow_update_geometry (ximagesink);
 655         g_mutex_lock (&ximagesink->x_lock);
 656         configured = TRUE;
 657         break;
 658       default:
 659         break;
 660     }
 661   }
 662
 663   if (ximagesink->handle_expose && (exposed || configured)) {
 664     g_mutex_unlock (&ximagesink->x_lock);
 665     g_mutex_unlock (&ximagesink->flow_lock);
 666
 667     gst_ximagesink_expose (GST_VIDEO_OVERLAY (ximagesink));
 668
 669     g_mutex_lock (&ximagesink->flow_lock);
 670     g_mutex_lock (&ximagesink->x_lock);
 671   }
 672
 673   /* Handle Display events */
 674   while (XPending (ximagesink->xcontext->disp)) {
 675     XNextEvent (ximagesink->xcontext->disp, &e);
 676
 677     switch (e.type) {
 678       case ClientMessage:{
 679         Atom wm_delete;
 680
 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));
 687
 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);
 692         }
 693         break;
 694       }
 695       default:
 696         break;
 697     }
 698   }
 699
 700   g_mutex_unlock (&ximagesink->x_lock);
 701   g_mutex_unlock (&ximagesink->flow_lock);
 702 }
 703
 704 static gpointer
 705 gst_ximagesink_event_thread (GstXImageSink * ximagesink)
 706 {
 707   g_return_val_if_fail (GST_IS_XIMAGESINK (ximagesink), NULL);
 708
 709   GST_OBJECT_LOCK (ximagesink);
 710   while (ximagesink->running) {
 711     GST_OBJECT_UNLOCK (ximagesink);
 712
 713     if (ximagesink->xwindow) {
 714       gst_ximagesink_handle_xevents (ximagesink);
 715     }
 716     /* FIXME: do we want to align this with the framerate or anything else? */
 717     g_usleep (G_USEC_PER_SEC / 20);
 718
 719     GST_OBJECT_LOCK (ximagesink);
 720   }
 721   GST_OBJECT_UNLOCK (ximagesink);
 722
 723   return NULL;
 724 }
 725
 726 static void
 727 gst_ximagesink_manage_event_thread (GstXImageSink * ximagesink)
 728 {
 729   GThread *thread = NULL;
 730
 731   /* don't start the thread too early */
 732   if (ximagesink->xcontext == NULL) {
 733     return;
 734   }
 735
 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);
 745     }
 746   } else {
 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;
 754     }
 755   }
 756   GST_OBJECT_UNLOCK (ximagesink);
 757
 758   /* Wait for our event thread to finish */
 759   if (thread)
 760     g_thread_join (thread);
 761
 762 }
 763
 764
 765 /* This function calculates the pixel aspect ratio based on the properties
 766  * in the xcontext structure and stores it there. */
 767 static void
 768 gst_ximagesink_calculate_pixel_aspect_ratio (GstXContext * xcontext)
 769 {
 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 */
 778   };
 779   gint i;
 780   gint index;
 781   gdouble ratio;
 782   gdouble delta;
 783
 784 #define DELTA(idx) (ABS (ratio - ((gdouble) par[idx][0] / par[idx][1])))
 785
 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);
 790
 791   /* DirectFB's X in 720x576 reports the physical dimensions wrong, so
 792    * override here */
 793   if (xcontext->width == 720 && xcontext->height == 576) {
 794     ratio = 4.0 * 576 / (3.0 * 720);
 795   }
 796   GST_DEBUG ("calculated pixel aspect ratio: %f", ratio);
 797
 798   /* now find the one from par[][2] with the lowest delta to the real one */
 799   delta = DELTA (0);
 800   index = 0;
 801
 802   for (i = 1; i < sizeof (par) / (sizeof (gint) * 2); ++i) {
 803     gdouble this_delta = DELTA (i);
 804
 805     if (this_delta < delta) {
 806       index = i;
 807       delta = this_delta;
 808     }
 809   }
 810
 811   GST_DEBUG ("Decided on index %d (%d/%d)", index,
 812       par[index][0], par[index][1]);
 813
 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));
 821 }
 822
 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
 826    image creation */
 827 static GstXContext *
 828 gst_ximagesink_xcontext_get (GstXImageSink * ximagesink)
 829 {
 830   GstXContext *xcontext = NULL;
 831   XPixmapFormatValues *px_formats = NULL;
 832   gint nb_formats = 0, i;
 833   gint endianness;
 834   GstVideoFormat vformat;
 835
 836   g_return_val_if_fail (GST_IS_XIMAGESINK (ximagesink), NULL);
 837
 838   xcontext = g_new0 (GstXContext, 1);
 839
 840   g_mutex_lock (&ximagesink->x_lock);
 841
 842   xcontext->disp = XOpenDisplay (ximagesink->display_name);
 843
 844   if (!xcontext->disp) {
 845     g_mutex_unlock (&ximagesink->x_lock);
 846     g_free (xcontext);
 847     GST_ELEMENT_ERROR (ximagesink, RESOURCE, WRITE,
 848         ("Could not initialise X output"), ("Could not open display"));
 849     return NULL;
 850   }
 851
 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);
 859
 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);
 864
 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);
 867
 868   gst_ximagesink_calculate_pixel_aspect_ratio (xcontext);
 869
 870   /* We get supported pixmap formats at supported depth */
 871   px_formats = XListPixmapFormats (xcontext->disp, &nb_formats);
 872
 873   if (!px_formats) {
 874     XCloseDisplay (xcontext->disp);
 875     g_mutex_unlock (&ximagesink->x_lock);
 876     g_free (xcontext->par);
 877     g_free (xcontext);
 878     GST_ELEMENT_ERROR (ximagesink, RESOURCE, SETTINGS,
 879         ("Could not get supported pixmap formats"), (NULL));
 880     return NULL;
 881   }
 882
 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;
 887   }
 888
 889   XFree (px_formats);
 890
 891   endianness = (ImageByteOrder (xcontext->disp) ==
 892       LSBFirst) ? G_LITTLE_ENDIAN : G_BIG_ENDIAN;
 893
 894   /* Search for XShm extension support */
 895 #ifdef HAVE_XSHM
 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");
 900   } else
 901 #endif /* HAVE_XSHM */
 902   {
 903     xcontext->use_xshm = FALSE;
 904     GST_DEBUG ("ximagesink is not using XShm extension");
 905   }
 906
 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);
 910
 911   if (vformat == GST_VIDEO_FORMAT_UNKNOWN)
 912     goto unknown_format;
 913
 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");
 919   }
 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) {
 926     int nom, den;
 927
 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);
 932   }
 933
 934   g_mutex_unlock (&ximagesink->x_lock);
 935
 936   return xcontext;
 937
 938   /* ERRORS */
 939 unknown_format:
 940   {
 941     GST_ERROR_OBJECT (ximagesink, "unknown format");
 942     return NULL;
 943   }
 944 }
 945
 946 /* This function cleans the X context. Closing the Display and unrefing the
 947    caps for supported formats. */
 948 static void
 949 gst_ximagesink_xcontext_clear (GstXImageSink * ximagesink)
 950 {
 951   GstXContext *xcontext;
 952
 953   g_return_if_fail (GST_IS_XIMAGESINK (ximagesink));
 954
 955   GST_OBJECT_LOCK (ximagesink);
 956   if (ximagesink->xcontext == NULL) {
 957     GST_OBJECT_UNLOCK (ximagesink);
 958     return;
 959   }
 960
 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;
 966
 967   GST_OBJECT_UNLOCK (ximagesink);
 968
 969   gst_caps_unref (xcontext->caps);
 970   g_free (xcontext->par);
 971   g_free (ximagesink->par);
 972   ximagesink->par = NULL;
 973
 974   if (xcontext->last_caps)
 975     gst_caps_replace (&xcontext->last_caps, NULL);
 976
 977   g_mutex_lock (&ximagesink->x_lock);
 978
 979   XCloseDisplay (xcontext->disp);
 980
 981   g_mutex_unlock (&ximagesink->x_lock);
 982
 983   g_free (xcontext);
 984 }
 985
 986 /* Element stuff */
 987
 988 static GstCaps *
 989 gst_ximagesink_getcaps (GstBaseSink * bsink, GstCaps * filter)
 990 {
 991   GstXImageSink *ximagesink;
 992   GstCaps *caps;
 993   int i;
 994
 995   ximagesink = GST_XIMAGESINK (bsink);
 996
 997   g_mutex_lock (&ximagesink->x_lock);
 998   if (ximagesink->xcontext) {
 999     GstCaps *caps;
1000
1001     caps = gst_caps_ref (ximagesink->xcontext->caps);
1002
1003     if (filter) {
1004       GstCaps *intersection;
1005
1006       intersection =
1007           gst_caps_intersect_full (filter, caps, GST_CAPS_INTERSECT_FIRST);
1008       gst_caps_unref (caps);
1009       caps = intersection;
1010     }
1011
1012     if (ximagesink->xwindow && ximagesink->xwindow->width) {
1013       GstStructure *s0, *s1;
1014
1015       caps = gst_caps_make_writable (caps);
1016
1017       /* There can only be a single structure because the xcontext
1018        * caps only have a single structure */
1019       s0 = gst_caps_get_structure (caps, 0);
1020       s1 = gst_structure_copy (gst_caps_get_structure (caps, 0));
1021
1022       gst_structure_set (s0, "width", G_TYPE_INT, ximagesink->xwindow->width,
1023           "height", G_TYPE_INT, ximagesink->xwindow->height, NULL);
1024       gst_caps_append_structure (caps, s1);
1025
1026       /* This will not change the order but will remove the
1027        * fixed width/height caps again if not possible
1028        * upstream */
1029       if (filter) {
1030         GstCaps *intersection;
1031
1032         intersection =
1033             gst_caps_intersect_full (caps, filter, GST_CAPS_INTERSECT_FIRST);
1034         gst_caps_unref (caps);
1035         caps = intersection;
1036       }
1037     }
1038
1039     g_mutex_unlock (&ximagesink->x_lock);
1040     return caps;
1041   }
1042   g_mutex_unlock (&ximagesink->x_lock);
1043
1044   /* get a template copy and add the pixel aspect ratio */
1045   caps = gst_pad_get_pad_template_caps (GST_BASE_SINK (ximagesink)->sinkpad);
1046   if (ximagesink->par) {
1047     caps = gst_caps_make_writable (caps);
1048     for (i = 0; i < gst_caps_get_size (caps); ++i) {
1049       GstStructure *structure = gst_caps_get_structure (caps, i);
1050       int nom, den;
1051
1052       nom = gst_value_get_fraction_numerator (ximagesink->par);
1053       den = gst_value_get_fraction_denominator (ximagesink->par);
1054       gst_structure_set (structure, "pixel-aspect-ratio",
1055           GST_TYPE_FRACTION, nom, den, NULL);
1056     }
1057   }
1058
1059   if (filter) {
1060     GstCaps *intersection;
1061
1062     intersection =
1063         gst_caps_intersect_full (filter, caps, GST_CAPS_INTERSECT_FIRST);
1064     gst_caps_unref (caps);
1065     caps = intersection;
1066   }
1067
1068   return caps;
1069 }
1070
1071 static gboolean
1072 gst_ximagesink_setcaps (GstBaseSink * bsink, GstCaps * caps)
1073 {
1074   GstXImageSink *ximagesink;
1075   GstStructure *structure;
1076   GstVideoInfo info;
1077   GstBufferPool *newpool, *oldpool;
1078   const GValue *par;
1079   gint size;
1080   static GstAllocationParams params = { 0, 15, 0, 0, };
1081
1082   ximagesink = GST_XIMAGESINK (bsink);
1083
1084   if (!ximagesink->xcontext)
1085     return FALSE;
1086
1087   GST_DEBUG_OBJECT (ximagesink,
1088       "sinkconnect possible caps %" GST_PTR_FORMAT " with given caps %"
1089       GST_PTR_FORMAT, ximagesink->xcontext->caps, caps);
1090
1091   /* We intersect those caps with our template to make sure they are correct */
1092   if (!gst_caps_can_intersect (ximagesink->xcontext->caps, caps))
1093     goto incompatible_caps;
1094
1095   if (!gst_video_info_from_caps (&info, caps))
1096     goto invalid_format;
1097
1098   size = info.size;
1099
1100   structure = gst_caps_get_structure (caps, 0);
1101   /* if the caps contain pixel-aspect-ratio, they have to match ours,
1102    * otherwise linking should fail */
1103   par = gst_structure_get_value (structure, "pixel-aspect-ratio");
1104   if (par) {
1105     if (ximagesink->par) {
1106       if (gst_value_compare (par, ximagesink->par) != GST_VALUE_EQUAL) {
1107         goto wrong_aspect;
1108       }
1109     } else if (ximagesink->xcontext->par) {
1110       if (gst_value_compare (par, ximagesink->xcontext->par) != GST_VALUE_EQUAL) {
1111         goto wrong_aspect;
1112       }
1113     }
1114   }
1115
1116   GST_VIDEO_SINK_WIDTH (ximagesink) = info.width;
1117   GST_VIDEO_SINK_HEIGHT (ximagesink) = info.height;
1118   ximagesink->fps_n = info.fps_n;
1119   ximagesink->fps_d = info.fps_d;
1120
1121   /* Notify application to set xwindow id now */
1122   g_mutex_lock (&ximagesink->flow_lock);
1123   if (!ximagesink->xwindow) {
1124     g_mutex_unlock (&ximagesink->flow_lock);
1125     gst_video_overlay_prepare_window_handle (GST_VIDEO_OVERLAY (ximagesink));
1126   } else {
1127     g_mutex_unlock (&ximagesink->flow_lock);
1128   }
1129
1130   /* Creating our window and our image */
1131   if (GST_VIDEO_SINK_WIDTH (ximagesink) <= 0 ||
1132       GST_VIDEO_SINK_HEIGHT (ximagesink) <= 0)
1133     goto invalid_size;
1134
1135   g_mutex_lock (&ximagesink->flow_lock);
1136   if (!ximagesink->xwindow) {
1137     ximagesink->xwindow = gst_ximagesink_xwindow_new (ximagesink,
1138         GST_VIDEO_SINK_WIDTH (ximagesink), GST_VIDEO_SINK_HEIGHT (ximagesink));
1139   }
1140
1141   ximagesink->info = info;
1142
1143   /* Remember to draw borders for next frame */
1144   ximagesink->draw_border = TRUE;
1145
1146   /* create a new pool for the new configuration */
1147   newpool = gst_ximage_buffer_pool_new (ximagesink);
1148
1149   structure = gst_buffer_pool_get_config (newpool);
1150   gst_buffer_pool_config_set_params (structure, caps, size, 2, 0);
1151   gst_buffer_pool_config_set_allocator (structure, NULL, &params);
1152   if (!gst_buffer_pool_set_config (newpool, structure))
1153     goto config_failed;
1154
1155   oldpool = ximagesink->pool;
1156   /* we don't activate the pool yet, this will be done by downstream after it
1157    * has configured the pool. If downstream does not want our pool we will
1158    * activate it when we render into it */
1159   ximagesink->pool = newpool;
1160   g_mutex_unlock (&ximagesink->flow_lock);
1161
1162   /* unref the old sink */
1163   if (oldpool) {
1164     /* we don't deactivate, some elements might still be using it, it will be
1165      * deactivated when the last ref is gone */
1166     gst_object_unref (oldpool);
1167   }
1168
1169   return TRUE;
1170
1171   /* ERRORS */
1172 incompatible_caps:
1173   {
1174     GST_ERROR_OBJECT (ximagesink, "caps incompatible");
1175     return FALSE;
1176   }
1177 invalid_format:
1178   {
1179     GST_ERROR_OBJECT (ximagesink, "caps invalid");
1180     return FALSE;
1181   }
1182 wrong_aspect:
1183   {
1184     GST_INFO_OBJECT (ximagesink, "pixel aspect ratio does not match");
1185     return FALSE;
1186   }
1187 invalid_size:
1188   {
1189     GST_ELEMENT_ERROR (ximagesink, CORE, NEGOTIATION, (NULL),
1190         ("Invalid image size."));
1191     return FALSE;
1192   }
1193 config_failed:
1194   {
1195     GST_ERROR_OBJECT (ximagesink, "failed to set config.");
1196     g_mutex_unlock (&ximagesink->flow_lock);
1197     return FALSE;
1198   }
1199 }
1200
1201 static GstStateChangeReturn
1202 gst_ximagesink_change_state (GstElement * element, GstStateChange transition)
1203 {
1204   GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
1205   GstXImageSink *ximagesink;
1206   GstXContext *xcontext = NULL;
1207
1208   ximagesink = GST_XIMAGESINK (element);
1209
1210   switch (transition) {
1211     case GST_STATE_CHANGE_NULL_TO_READY:
1212       /* Initializing the XContext */
1213       if (ximagesink->xcontext == NULL) {
1214         xcontext = gst_ximagesink_xcontext_get (ximagesink);
1215         if (xcontext == NULL) {
1216           ret = GST_STATE_CHANGE_FAILURE;
1217           goto beach;
1218         }
1219         GST_OBJECT_LOCK (ximagesink);
1220         if (xcontext)
1221           ximagesink->xcontext = xcontext;
1222         GST_OBJECT_UNLOCK (ximagesink);
1223       }
1224
1225       /* call XSynchronize with the current value of synchronous */
1226       GST_DEBUG_OBJECT (ximagesink, "XSynchronize called with %s",
1227           ximagesink->synchronous ? "TRUE" : "FALSE");
1228       g_mutex_lock (&ximagesink->x_lock);
1229       XSynchronize (ximagesink->xcontext->disp, ximagesink->synchronous);
1230       g_mutex_unlock (&ximagesink->x_lock);
1231       gst_ximagesink_manage_event_thread (ximagesink);
1232       break;
1233     case GST_STATE_CHANGE_READY_TO_PAUSED:
1234       g_mutex_lock (&ximagesink->flow_lock);
1235       if (ximagesink->xwindow)
1236         gst_ximagesink_xwindow_clear (ximagesink, ximagesink->xwindow);
1237       g_mutex_unlock (&ximagesink->flow_lock);
1238       break;
1239     case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
1240       break;
1241     default:
1242       break;
1243   }
1244
1245   ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
1246
1247   switch (transition) {
1248     case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
1249       break;
1250     case GST_STATE_CHANGE_PAUSED_TO_READY:
1251       ximagesink->fps_n = 0;
1252       ximagesink->fps_d = 1;
1253       GST_VIDEO_SINK_WIDTH (ximagesink) = 0;
1254       GST_VIDEO_SINK_HEIGHT (ximagesink) = 0;
1255       g_mutex_lock (&ximagesink->flow_lock);
1256       if (ximagesink->pool)
1257         gst_buffer_pool_set_active (ximagesink->pool, FALSE);
1258       g_mutex_unlock (&ximagesink->flow_lock);
1259       break;
1260     case GST_STATE_CHANGE_READY_TO_NULL:
1261       gst_ximagesink_reset (ximagesink);
1262       break;
1263     default:
1264       break;
1265   }
1266
1267 beach:
1268   return ret;
1269 }
1270
1271 static void
1272 gst_ximagesink_get_times (GstBaseSink * bsink, GstBuffer * buf,
1273     GstClockTime * start, GstClockTime * end)
1274 {
1275   GstXImageSink *ximagesink;
1276
1277   ximagesink = GST_XIMAGESINK (bsink);
1278
1279   if (GST_BUFFER_TIMESTAMP_IS_VALID (buf)) {
1280     *start = GST_BUFFER_TIMESTAMP (buf);
1281     if (GST_BUFFER_DURATION_IS_VALID (buf)) {
1282       *end = *start + GST_BUFFER_DURATION (buf);
1283     } else {
1284       if (ximagesink->fps_n > 0) {
1285         *end = *start +
1286             gst_util_uint64_scale_int (GST_SECOND, ximagesink->fps_d,
1287             ximagesink->fps_n);
1288       }
1289     }
1290   }
1291 }
1292
1293 static GstFlowReturn
1294 gst_ximagesink_show_frame (GstVideoSink * vsink, GstBuffer * buf)
1295 {
1296   GstFlowReturn res;
1297   GstXImageSink *ximagesink;
1298   GstXImageMeta *meta;
1299   GstBuffer *to_put = NULL;
1300
1301   ximagesink = GST_XIMAGESINK (vsink);
1302
1303   meta = gst_buffer_get_ximage_meta (buf);
1304
1305   if (meta && meta->sink == ximagesink) {
1306     /* If this buffer has been allocated using our buffer management we simply
1307        put the ximage which is in the PRIVATE pointer */
1308     GST_LOG_OBJECT (ximagesink, "buffer from our pool, writing directly");
1309     to_put = buf;
1310     res = GST_FLOW_OK;
1311   } else {
1312     GstVideoFrame src, dest;
1313     GstBufferPoolAcquireParams params = { 0, };
1314
1315     /* Else we have to copy the data into our private image, */
1316     /* if we have one... */
1317     GST_LOG_OBJECT (ximagesink, "buffer not from our pool, copying");
1318
1319     /* we should have a pool, configured in setcaps */
1320     if (ximagesink->pool == NULL)
1321       goto no_pool;
1322
1323     if (!gst_buffer_pool_set_active (ximagesink->pool, TRUE))
1324       goto activate_failed;
1325
1326     /* take a buffer from our pool, if there is no buffer in the pool something
1327      * is seriously wrong, waiting for the pool here might deadlock when we try
1328      * to go to PAUSED because we never flush the pool. */
1329     params.flags = GST_BUFFER_POOL_ACQUIRE_FLAG_DONTWAIT;
1330     res = gst_buffer_pool_acquire_buffer (ximagesink->pool, &to_put, &params);
1331     if (res != GST_FLOW_OK)
1332       goto no_buffer;
1333
1334     GST_CAT_LOG_OBJECT (GST_CAT_PERFORMANCE, ximagesink,
1335         "slow copy into bufferpool buffer %p", to_put);
1336
1337     if (!gst_video_frame_map (&src, &ximagesink->info, buf, GST_MAP_READ))
1338       goto invalid_buffer;
1339
1340     if (!gst_video_frame_map (&dest, &ximagesink->info, to_put, GST_MAP_WRITE)) {
1341       gst_video_frame_unmap (&src);
1342       goto invalid_buffer;
1343     }
1344
1345     gst_video_frame_copy (&dest, &src);
1346
1347     gst_video_frame_unmap (&dest);
1348     gst_video_frame_unmap (&src);
1349   }
1350
1351   if (!gst_ximagesink_ximage_put (ximagesink, to_put))
1352     goto no_window;
1353
1354 done:
1355   if (to_put != buf)
1356     gst_buffer_unref (to_put);
1357
1358   return res;
1359
1360   /* ERRORS */
1361 no_pool:
1362   {
1363     GST_ELEMENT_ERROR (ximagesink, RESOURCE, WRITE,
1364         ("Internal error: can't allocate images"),
1365         ("We don't have a bufferpool negotiated"));
1366     return GST_FLOW_ERROR;
1367   }
1368 no_buffer:
1369   {
1370     /* No image available. That's very bad ! */
1371     GST_WARNING_OBJECT (ximagesink, "could not create image");
1372     return GST_FLOW_OK;
1373   }
1374 invalid_buffer:
1375   {
1376     /* No Window available to put our image into */
1377     GST_WARNING_OBJECT (ximagesink, "could not map image");
1378     res = GST_FLOW_OK;
1379     goto done;
1380   }
1381 no_window:
1382   {
1383     /* No Window available to put our image into */
1384     GST_WARNING_OBJECT (ximagesink, "could not output image - no window");
1385     res = GST_FLOW_ERROR;
1386     goto done;
1387   }
1388 activate_failed:
1389   {
1390     GST_ERROR_OBJECT (ximagesink, "failed to activate bufferpool.");
1391     res = GST_FLOW_ERROR;
1392     goto done;
1393   }
1394 }
1395
1396 static gboolean
1397 gst_ximagesink_event (GstBaseSink * sink, GstEvent * event)
1398 {
1399   GstXImageSink *ximagesink = GST_XIMAGESINK (sink);
1400
1401   switch (GST_EVENT_TYPE (event)) {
1402     case GST_EVENT_TAG:{
1403       GstTagList *l;
1404       gchar *title = NULL;
1405
1406       gst_event_parse_tag (event, &l);
1407       gst_tag_list_get_string (l, GST_TAG_TITLE, &title);
1408
1409       if (title) {
1410         GST_DEBUG_OBJECT (ximagesink, "got tags, title='%s'", title);
1411         gst_ximagesink_xwindow_set_title (ximagesink, ximagesink->xwindow,
1412             title);
1413
1414         g_free (title);
1415       }
1416       break;
1417     }
1418     default:
1419       break;
1420   }
1421   return GST_BASE_SINK_CLASS (parent_class)->event (sink, event);
1422 }
1423
1424 static gboolean
1425 gst_ximagesink_propose_allocation (GstBaseSink * bsink, GstQuery * query)
1426 {
1427   GstXImageSink *ximagesink = GST_XIMAGESINK (bsink);
1428   GstBufferPool *pool;
1429   GstStructure *config;
1430   GstCaps *caps;
1431   guint size;
1432   gboolean need_pool;
1433
1434   gst_query_parse_allocation (query, &caps, &need_pool);
1435
1436   if (caps == NULL)
1437     goto no_caps;
1438
1439   g_mutex_lock (&ximagesink->flow_lock);
1440   if ((pool = ximagesink->pool))
1441     gst_object_ref (pool);
1442   g_mutex_unlock (&ximagesink->flow_lock);
1443
1444   if (pool != NULL) {
1445     GstCaps *pcaps;
1446
1447     /* we had a pool, check caps */
1448     config = gst_buffer_pool_get_config (pool);
1449     gst_buffer_pool_config_get_params (config, &pcaps, &size, NULL, NULL);
1450
1451     GST_DEBUG_OBJECT (ximagesink,
1452         "we had a pool with caps %" GST_PTR_FORMAT, pcaps);
1453     if (!gst_caps_is_equal (caps, pcaps)) {
1454       /* different caps, we can't use this pool */
1455       GST_DEBUG_OBJECT (ximagesink, "pool has different caps");
1456       gst_object_unref (pool);
1457       pool = NULL;
1458     }
1459     gst_structure_free (config);
1460   }
1461   if (pool == NULL && need_pool) {
1462     GstVideoInfo info;
1463
1464     if (!gst_video_info_from_caps (&info, caps))
1465       goto invalid_caps;
1466
1467     GST_DEBUG_OBJECT (ximagesink, "create new pool");
1468     pool = gst_ximage_buffer_pool_new (ximagesink);
1469
1470     /* the normal size of a frame */
1471     size = info.size;
1472
1473     config = gst_buffer_pool_get_config (pool);
1474     gst_buffer_pool_config_set_params (config, caps, size, 0, 0);
1475     if (!gst_buffer_pool_set_config (pool, config))
1476       goto config_failed;
1477   }
1478   if (pool) {
1479     /* we need at least 2 buffer because we hold on to the last one */
1480     gst_query_add_allocation_pool (query, pool, size, 2, 0);
1481     gst_object_unref (pool);
1482   }
1483
1484   /* we also support various metadata */
1485   gst_query_add_allocation_meta (query, GST_VIDEO_META_API_TYPE, NULL);
1486   gst_query_add_allocation_meta (query, GST_VIDEO_CROP_META_API_TYPE, NULL);
1487
1488   return TRUE;
1489
1490   /* ERRORS */
1491 no_caps:
1492   {
1493     GST_DEBUG_OBJECT (bsink, "no caps specified");
1494     return FALSE;
1495   }
1496 invalid_caps:
1497   {
1498     GST_DEBUG_OBJECT (bsink, "invalid caps specified");
1499     return FALSE;
1500   }
1501 config_failed:
1502   {
1503     GST_DEBUG_OBJECT (bsink, "failed setting config");
1504     gst_object_unref (pool);
1505     return FALSE;
1506   }
1507 }
1508
1509 /* Interfaces stuff */
1510 static void
1511 gst_ximagesink_navigation_send_event (GstNavigation * navigation,
1512     GstStructure * structure)
1513 {
1514   GstXImageSink *ximagesink = GST_XIMAGESINK (navigation);
1515   GstEvent *event;
1516   gint x_offset, y_offset;
1517   gdouble x, y;
1518   GstPad *pad = NULL;
1519
1520   event = gst_event_new_navigation (structure);
1521
1522   /* We are not converting the pointer coordinates as there's no hardware
1523      scaling done here. The only possible scaling is done by videoscale and
1524      videoscale will have to catch those events and tranform the coordinates
1525      to match the applied scaling. So here we just add the offset if the image
1526      is centered in the window.  */
1527
1528   /* We take the flow_lock while we look at the window */
1529   g_mutex_lock (&ximagesink->flow_lock);
1530
1531   if (!ximagesink->xwindow) {
1532     g_mutex_unlock (&ximagesink->flow_lock);
1533     return;
1534   }
1535
1536   x_offset = ximagesink->xwindow->width - GST_VIDEO_SINK_WIDTH (ximagesink);
1537   y_offset = ximagesink->xwindow->height - GST_VIDEO_SINK_HEIGHT (ximagesink);
1538
1539   g_mutex_unlock (&ximagesink->flow_lock);
1540
1541   if (x_offset > 0 && gst_structure_get_double (structure, "pointer_x", &x)) {
1542     x -= x_offset / 2;
1543     gst_structure_set (structure, "pointer_x", G_TYPE_DOUBLE, x, NULL);
1544   }
1545   if (y_offset > 0 && gst_structure_get_double (structure, "pointer_y", &y)) {
1546     y -= y_offset / 2;
1547     gst_structure_set (structure, "pointer_y", G_TYPE_DOUBLE, y, NULL);
1548   }
1549
1550   pad = gst_pad_get_peer (GST_VIDEO_SINK_PAD (ximagesink));
1551
1552   if (GST_IS_PAD (pad) && GST_IS_EVENT (event)) {
1553     gst_pad_send_event (pad, event);
1554
1555     gst_object_unref (pad);
1556   }
1557 }
1558
1559 static void
1560 gst_ximagesink_navigation_init (GstNavigationInterface * iface)
1561 {
1562   iface->send_event = gst_ximagesink_navigation_send_event;
1563 }
1564
1565 static void
1566 gst_ximagesink_set_window_handle (GstVideoOverlay * overlay, guintptr id)
1567 {
1568   XID xwindow_id = id;
1569   GstXImageSink *ximagesink = GST_XIMAGESINK (overlay);
1570   GstXWindow *xwindow = NULL;
1571   XWindowAttributes attr;
1572
1573   /* We acquire the stream lock while setting this window in the element.
1574      We are basically cleaning tons of stuff replacing the old window, putting
1575      images while we do that would surely crash */
1576   g_mutex_lock (&ximagesink->flow_lock);
1577
1578   /* If we already use that window return */
1579   if (ximagesink->xwindow && (xwindow_id == ximagesink->xwindow->win)) {
1580     g_mutex_unlock (&ximagesink->flow_lock);
1581     return;
1582   }
1583
1584   /* If the element has not initialized the X11 context try to do so */
1585   if (!ximagesink->xcontext &&
1586       !(ximagesink->xcontext = gst_ximagesink_xcontext_get (ximagesink))) {
1587     g_mutex_unlock (&ximagesink->flow_lock);
1588     /* we have thrown a GST_ELEMENT_ERROR now */
1589     return;
1590   }
1591
1592   /* If a window is there already we destroy it */
1593   if (ximagesink->xwindow) {
1594     gst_ximagesink_xwindow_destroy (ximagesink, ximagesink->xwindow);
1595     ximagesink->xwindow = NULL;
1596   }
1597
1598   /* If the xid is 0 we go back to an internal window */
1599   if (xwindow_id == 0) {
1600     /* If no width/height caps nego did not happen window will be created
1601        during caps nego then */
1602     if (GST_VIDEO_SINK_WIDTH (ximagesink) && GST_VIDEO_SINK_HEIGHT (ximagesink)) {
1603       xwindow = gst_ximagesink_xwindow_new (ximagesink,
1604           GST_VIDEO_SINK_WIDTH (ximagesink),
1605           GST_VIDEO_SINK_HEIGHT (ximagesink));
1606     }
1607   } else {
1608     xwindow = g_new0 (GstXWindow, 1);
1609
1610     xwindow->win = xwindow_id;
1611
1612     /* We get window geometry, set the event we want to receive,
1613        and create a GC */
1614     g_mutex_lock (&ximagesink->x_lock);
1615     XGetWindowAttributes (ximagesink->xcontext->disp, xwindow->win, &attr);
1616     xwindow->width = attr.width;
1617     xwindow->height = attr.height;
1618     xwindow->internal = FALSE;
1619     if (ximagesink->handle_events) {
1620       XSelectInput (ximagesink->xcontext->disp, xwindow->win, ExposureMask |
1621           StructureNotifyMask | PointerMotionMask | KeyPressMask |
1622           KeyReleaseMask);
1623     }
1624
1625     xwindow->gc = XCreateGC (ximagesink->xcontext->disp, xwindow->win, 0, NULL);
1626     g_mutex_unlock (&ximagesink->x_lock);
1627   }
1628
1629   if (xwindow)
1630     ximagesink->xwindow = xwindow;
1631
1632   g_mutex_unlock (&ximagesink->flow_lock);
1633 }
1634
1635 static void
1636 gst_ximagesink_expose (GstVideoOverlay * overlay)
1637 {
1638   GstXImageSink *ximagesink = GST_XIMAGESINK (overlay);
1639
1640   gst_ximagesink_xwindow_update_geometry (ximagesink);
1641   gst_ximagesink_ximage_put (ximagesink, NULL);
1642 }
1643
1644 static void
1645 gst_ximagesink_set_event_handling (GstVideoOverlay * overlay,
1646     gboolean handle_events)
1647 {
1648   GstXImageSink *ximagesink = GST_XIMAGESINK (overlay);
1649
1650   ximagesink->handle_events = handle_events;
1651
1652   g_mutex_lock (&ximagesink->flow_lock);
1653
1654   if (G_UNLIKELY (!ximagesink->xwindow)) {
1655     g_mutex_unlock (&ximagesink->flow_lock);
1656     return;
1657   }
1658
1659   g_mutex_lock (&ximagesink->x_lock);
1660
1661   if (handle_events) {
1662     if (ximagesink->xwindow->internal) {
1663       XSelectInput (ximagesink->xcontext->disp, ximagesink->xwindow->win,
1664           ExposureMask | StructureNotifyMask | PointerMotionMask |
1665           KeyPressMask | KeyReleaseMask | ButtonPressMask | ButtonReleaseMask);
1666     } else {
1667       XSelectInput (ximagesink->xcontext->disp, ximagesink->xwindow->win,
1668           ExposureMask | StructureNotifyMask | PointerMotionMask |
1669           KeyPressMask | KeyReleaseMask);
1670     }
1671   } else {
1672     XSelectInput (ximagesink->xcontext->disp, ximagesink->xwindow->win, 0);
1673   }
1674
1675   g_mutex_unlock (&ximagesink->x_lock);
1676
1677   g_mutex_unlock (&ximagesink->flow_lock);
1678 }
1679
1680 static void
1681 gst_ximagesink_video_overlay_init (GstVideoOverlayInterface * iface)
1682 {
1683   iface->set_window_handle = gst_ximagesink_set_window_handle;
1684   iface->expose = gst_ximagesink_expose;
1685   iface->handle_events = gst_ximagesink_set_event_handling;
1686 }
1687
1688 /* =========================================== */
1689 /*                                             */
1690 /*              Init & Class init              */
1691 /*                                             */
1692 /* =========================================== */
1693
1694 static void
1695 gst_ximagesink_set_property (GObject * object, guint prop_id,
1696     const GValue * value, GParamSpec * pspec)
1697 {
1698   GstXImageSink *ximagesink;
1699
1700   g_return_if_fail (GST_IS_XIMAGESINK (object));
1701
1702   ximagesink = GST_XIMAGESINK (object);
1703
1704   switch (prop_id) {
1705     case PROP_DISPLAY:
1706       ximagesink->display_name = g_strdup (g_value_get_string (value));
1707       break;
1708     case PROP_SYNCHRONOUS:
1709       ximagesink->synchronous = g_value_get_boolean (value);
1710       if (ximagesink->xcontext) {
1711         GST_DEBUG_OBJECT (ximagesink, "XSynchronize called with %s",
1712             ximagesink->synchronous ? "TRUE" : "FALSE");
1713         g_mutex_lock (&ximagesink->x_lock);
1714         XSynchronize (ximagesink->xcontext->disp, ximagesink->synchronous);
1715         g_mutex_unlock (&ximagesink->x_lock);
1716       }
1717       break;
1718     case PROP_FORCE_ASPECT_RATIO:
1719       ximagesink->keep_aspect = g_value_get_boolean (value);
1720       break;
1721     case PROP_PIXEL_ASPECT_RATIO:
1722     {
1723       GValue *tmp;
1724
1725       tmp = g_new0 (GValue, 1);
1726       g_value_init (tmp, GST_TYPE_FRACTION);
1727
1728       if (!g_value_transform (value, tmp)) {
1729         GST_WARNING_OBJECT (ximagesink,
1730             "Could not transform string to aspect ratio");
1731         g_free (tmp);
1732       } else {
1733         GST_DEBUG_OBJECT (ximagesink, "set PAR to %d/%d",
1734             gst_value_get_fraction_numerator (tmp),
1735             gst_value_get_fraction_denominator (tmp));
1736         g_free (ximagesink->par);
1737         ximagesink->par = tmp;
1738       }
1739     }
1740       break;
1741     case PROP_HANDLE_EVENTS:
1742       gst_ximagesink_set_event_handling (GST_VIDEO_OVERLAY (ximagesink),
1743           g_value_get_boolean (value));
1744       gst_ximagesink_manage_event_thread (ximagesink);
1745       break;
1746     case PROP_HANDLE_EXPOSE:
1747       ximagesink->handle_expose = g_value_get_boolean (value);
1748       gst_ximagesink_manage_event_thread (ximagesink);
1749       break;
1750     default:
1751       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1752       break;
1753   }
1754 }
1755
1756 static void
1757 gst_ximagesink_get_property (GObject * object, guint prop_id,
1758     GValue * value, GParamSpec * pspec)
1759 {
1760   GstXImageSink *ximagesink;
1761
1762   g_return_if_fail (GST_IS_XIMAGESINK (object));
1763
1764   ximagesink = GST_XIMAGESINK (object);
1765
1766   switch (prop_id) {
1767     case PROP_DISPLAY:
1768       g_value_set_string (value, ximagesink->display_name);
1769       break;
1770     case PROP_SYNCHRONOUS:
1771       g_value_set_boolean (value, ximagesink->synchronous);
1772       break;
1773     case PROP_FORCE_ASPECT_RATIO:
1774       g_value_set_boolean (value, ximagesink->keep_aspect);
1775       break;
1776     case PROP_PIXEL_ASPECT_RATIO:
1777       if (ximagesink->par)
1778         g_value_transform (ximagesink->par, value);
1779       break;
1780     case PROP_HANDLE_EVENTS:
1781       g_value_set_boolean (value, ximagesink->handle_events);
1782       break;
1783     case PROP_HANDLE_EXPOSE:
1784       g_value_set_boolean (value, ximagesink->handle_expose);
1785       break;
1786     case PROP_WINDOW_WIDTH:
1787       if (ximagesink->xwindow)
1788         g_value_set_uint64 (value, ximagesink->xwindow->width);
1789       else
1790         g_value_set_uint64 (value, 0);
1791       break;
1792     case PROP_WINDOW_HEIGHT:
1793       if (ximagesink->xwindow)
1794         g_value_set_uint64 (value, ximagesink->xwindow->height);
1795       else
1796         g_value_set_uint64 (value, 0);
1797       break;
1798     default:
1799       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1800       break;
1801   }
1802 }
1803
1804 static void
1805 gst_ximagesink_reset (GstXImageSink * ximagesink)
1806 {
1807   GThread *thread;
1808
1809   GST_OBJECT_LOCK (ximagesink);
1810   ximagesink->running = FALSE;
1811   /* grab thread and mark it as NULL */
1812   thread = ximagesink->event_thread;
1813   ximagesink->event_thread = NULL;
1814   GST_OBJECT_UNLOCK (ximagesink);
1815
1816   /* Wait for our event thread to finish before we clean up our stuff. */
1817   if (thread)
1818     g_thread_join (thread);
1819
1820   if (ximagesink->cur_image) {
1821     gst_buffer_unref (ximagesink->cur_image);
1822     ximagesink->cur_image = NULL;
1823   }
1824
1825   g_mutex_lock (&ximagesink->flow_lock);
1826
1827   if (ximagesink->pool) {
1828     gst_object_unref (ximagesink->pool);
1829     ximagesink->pool = NULL;
1830   }
1831
1832   if (ximagesink->xwindow) {
1833     gst_ximagesink_xwindow_clear (ximagesink, ximagesink->xwindow);
1834     gst_ximagesink_xwindow_destroy (ximagesink, ximagesink->xwindow);
1835     ximagesink->xwindow = NULL;
1836   }
1837   g_mutex_unlock (&ximagesink->flow_lock);
1838
1839   gst_ximagesink_xcontext_clear (ximagesink);
1840 }
1841
1842 static void
1843 gst_ximagesink_finalize (GObject * object)
1844 {
1845   GstXImageSink *ximagesink;
1846
1847   ximagesink = GST_XIMAGESINK (object);
1848
1849   gst_ximagesink_reset (ximagesink);
1850
1851   if (ximagesink->display_name) {
1852     g_free (ximagesink->display_name);
1853     ximagesink->display_name = NULL;
1854   }
1855   if (ximagesink->par) {
1856     g_free (ximagesink->par);
1857     ximagesink->par = NULL;
1858   }
1859   g_mutex_clear (&ximagesink->x_lock);
1860   g_mutex_clear (&ximagesink->flow_lock);
1861
1862   g_free (ximagesink->media_title);
1863
1864   G_OBJECT_CLASS (parent_class)->finalize (object);
1865 }
1866
1867 static void
1868 gst_ximagesink_init (GstXImageSink * ximagesink)
1869 {
1870   ximagesink->display_name = NULL;
1871   ximagesink->xcontext = NULL;
1872   ximagesink->xwindow = NULL;
1873   ximagesink->cur_image = NULL;
1874
1875   ximagesink->event_thread = NULL;
1876   ximagesink->running = FALSE;
1877
1878   ximagesink->fps_n = 0;
1879   ximagesink->fps_d = 1;
1880
1881   g_mutex_init (&ximagesink->x_lock);
1882   g_mutex_init (&ximagesink->flow_lock);
1883
1884   ximagesink->par = NULL;
1885
1886   ximagesink->pool = NULL;
1887
1888   ximagesink->synchronous = FALSE;
1889   ximagesink->keep_aspect = TRUE;
1890   ximagesink->handle_events = TRUE;
1891   ximagesink->handle_expose = TRUE;
1892 }
1893
1894 static void
1895 gst_ximagesink_class_init (GstXImageSinkClass * klass)
1896 {
1897   GObjectClass *gobject_class;
1898   GstElementClass *gstelement_class;
1899   GstBaseSinkClass *gstbasesink_class;
1900   GstVideoSinkClass *videosink_class;
1901
1902   gobject_class = (GObjectClass *) klass;
1903   gstelement_class = (GstElementClass *) klass;
1904   gstbasesink_class = (GstBaseSinkClass *) klass;
1905   videosink_class = (GstVideoSinkClass *) klass;
1906
1907   gobject_class->finalize = gst_ximagesink_finalize;
1908   gobject_class->set_property = gst_ximagesink_set_property;
1909   gobject_class->get_property = gst_ximagesink_get_property;
1910
1911   g_object_class_install_property (gobject_class, PROP_DISPLAY,
1912       g_param_spec_string ("display", "Display", "X Display name",
1913           NULL, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
1914   g_object_class_install_property (gobject_class, PROP_SYNCHRONOUS,
1915       g_param_spec_boolean ("synchronous", "Synchronous",
1916           "When enabled, runs the X display in synchronous mode. "
1917           "(unrelated to A/V sync, used only for debugging)", FALSE,
1918           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
1919   g_object_class_install_property (gobject_class, PROP_FORCE_ASPECT_RATIO,
1920       g_param_spec_boolean ("force-aspect-ratio", "Force aspect ratio",
1921           "When enabled, reverse caps negotiation (scaling) will respect "
1922           "original aspect ratio", TRUE,
1923           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
1924   g_object_class_install_property (gobject_class, PROP_PIXEL_ASPECT_RATIO,
1925       g_param_spec_string ("pixel-aspect-ratio", "Pixel Aspect Ratio",
1926           "The pixel aspect ratio of the device", "1/1",
1927           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
1928   g_object_class_install_property (gobject_class, PROP_HANDLE_EVENTS,
1929       g_param_spec_boolean ("handle-events", "Handle XEvents",
1930           "When enabled, XEvents will be selected and handled", TRUE,
1931           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
1932   g_object_class_install_property (gobject_class, PROP_HANDLE_EXPOSE,
1933       g_param_spec_boolean ("handle-expose", "Handle expose",
1934           "When enabled, "
1935           "the current frame will always be drawn in response to X Expose "
1936           "events", TRUE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
1937
1938   /**
1939    * GstXImageSink:window-width
1940    *
1941    * Actual width of the video window.
1942    *
1943    * Since: 0.10.32
1944    */
1945   g_object_class_install_property (gobject_class, PROP_WINDOW_WIDTH,
1946       g_param_spec_uint64 ("window-width", "window-width",
1947           "Width of the window", 0, G_MAXUINT64, 0,
1948           G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
1949
1950   /**
1951    * GstXImageSink:window-height
1952    *
1953    * Actual height of the video window.
1954    *
1955    * Since: 0.10.32
1956    */
1957   g_object_class_install_property (gobject_class, PROP_WINDOW_HEIGHT,
1958       g_param_spec_uint64 ("window-height", "window-height",
1959           "Height of the window", 0, G_MAXUINT64, 0,
1960           G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
1961
1962   gst_element_class_set_static_metadata (gstelement_class,
1963       "Video sink", "Sink/Video",
1964       "A standard X based videosink", "Julien Moutte <julien@moutte.net>");
1965
1966   gst_element_class_add_pad_template (gstelement_class,
1967       gst_static_pad_template_get (&gst_ximagesink_sink_template_factory));
1968
1969   gstelement_class->change_state = gst_ximagesink_change_state;
1970
1971   gstbasesink_class->get_caps = GST_DEBUG_FUNCPTR (gst_ximagesink_getcaps);
1972   gstbasesink_class->set_caps = GST_DEBUG_FUNCPTR (gst_ximagesink_setcaps);
1973   gstbasesink_class->get_times = GST_DEBUG_FUNCPTR (gst_ximagesink_get_times);
1974   gstbasesink_class->propose_allocation =
1975       GST_DEBUG_FUNCPTR (gst_ximagesink_propose_allocation);
1976   gstbasesink_class->event = GST_DEBUG_FUNCPTR (gst_ximagesink_event);
1977
1978   videosink_class->show_frame = GST_DEBUG_FUNCPTR (gst_ximagesink_show_frame);
1979 }