gstvaapidisplay_x11.c 17.4 KB
Newer Older
gb's avatar
gb committed
1 2 3
/*
 *  gstvaapidisplay_x11.c - VA/X11 display abstraction
 *
4
 *  Copyright (C) 2010-2011 Splitted-Desktop Systems
5
 *    Author: Gwenole Beauchesne <gwenole.beauchesne@splitted-desktop.com>
6
 *  Copyright (C) 2011-2012 Intel Corporation
7
 *    Author: Gwenole Beauchesne <gwenole.beauchesne@intel.com>
gb's avatar
gb committed
8
 *
gb's avatar
gb committed
9 10 11 12
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public License
 *  as published by the Free Software Foundation; either version 2.1
 *  of the License, or (at your option) any later version.
gb's avatar
gb committed
13
 *
gb's avatar
gb committed
14
 *  This library is distributed in the hope that it will be useful,
gb's avatar
gb committed
15
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
gb's avatar
gb committed
16 17
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
gb's avatar
gb committed
18
 *
gb's avatar
gb committed
19 20 21 22
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free
 *  Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 *  Boston, MA 02110-1301 USA
gb's avatar
gb committed
23 24
 */

gb's avatar
gb committed
25
/**
gb's avatar
gb committed
26 27
 * SECTION:gstvaapidisplay_x11
 * @short_description: VA/X11 display abstraction
gb's avatar
gb committed
28 29
 */

30
#include "sysdeps.h"
31
#include <string.h>
gb's avatar
gb committed
32
#include "gstvaapiutils.h"
33
#include "gstvaapidisplay_priv.h"
34 35
#include "gstvaapidisplay_x11.h"
#include "gstvaapidisplay_x11_priv.h"
gb's avatar
gb committed
36

37 38 39 40
#ifdef HAVE_XRANDR
# include <X11/extensions/Xrandr.h>
#endif

41 42 43 44
#ifdef HAVE_XRENDER
# include <X11/extensions/Xrender.h>
#endif

gb's avatar
gb committed
45
#define DEBUG 1
gb's avatar
gb committed
46
#include "gstvaapidebug.h"
gb's avatar
gb committed
47

48 49 50 51
static const guint g_display_types =
    (1U << GST_VAAPI_DISPLAY_TYPE_X11) |
    (1U << GST_VAAPI_DISPLAY_TYPE_GLX);

52 53 54 55 56 57 58 59 60 61
static inline const gchar *
get_default_display_name(void)
{
    static const gchar *g_display_name;

    if (!g_display_name)
        g_display_name = getenv("DISPLAY");
    return g_display_name;
}

62 63
static gint
compare_display_name(gconstpointer a, gconstpointer b)
64
{
65 66
    const GstVaapiDisplayInfo * const info = a;
    const gchar *cached_name = info->display_name, *cached_name_end;
67 68
    const gchar *tested_name = b, *tested_name_end;
    guint cached_name_length, tested_name_length;
69

70 71
    g_return_val_if_fail(cached_name, FALSE);
    g_return_val_if_fail(tested_name, FALSE);
72 73 74 75

    cached_name_end = strchr(cached_name, ':');
    if (cached_name_end)
        cached_name_length = cached_name_end - cached_name;
76
    else
77
        cached_name_length = strlen(cached_name);
78

79 80 81 82 83 84 85 86 87 88 89 90 91
    tested_name_end = strchr(tested_name, ':');
    if (tested_name_end)
        tested_name_length = tested_name_end - tested_name;
    else
        tested_name_length = strlen(tested_name);

    if (cached_name_length != tested_name_length)
        return FALSE;
    if (strncmp(cached_name, tested_name, cached_name_length) != 0)
        return FALSE;

    /* XXX: handle screen number? */
    return TRUE;
92 93
}

94 95
/* Reconstruct a display name without our prefix */
static const gchar *
96
get_display_name(GstVaapiDisplayX11 *display)
97
{
98 99
    GstVaapiDisplayX11Private * const priv = &display->priv;
    const gchar *display_name = priv->display_name;
100

101
    if (!display_name || *display_name == '\0')
102 103 104 105 106
        return NULL;
    return display_name;
}

/* Mangle display name with our prefix */
107
static gboolean
108 109
set_display_name(GstVaapiDisplayX11 *display, const gchar *display_name)
{
110
    GstVaapiDisplayX11Private * const priv = &display->priv;
111 112 113

    g_free(priv->display_name);

114 115 116 117 118
    if (!display_name) {
        display_name = get_default_display_name();
        if (!display_name)
            display_name = "";
    }
119
    priv->display_name = g_strdup(display_name);
120
    return priv->display_name != NULL;
121 122
}

123
/* Set synchronous behavious on the underlying X11 display */
gb's avatar
gb committed
124 125 126
static void
set_synchronous(GstVaapiDisplayX11 *display, gboolean synchronous)
{
127
    GstVaapiDisplayX11Private * const priv = &display->priv;
gb's avatar
gb committed
128 129 130

    if (priv->synchronous != synchronous) {
        priv->synchronous = synchronous;
131 132
        if (priv->x11_display) {
            GST_VAAPI_DISPLAY_LOCK(display);
gb's avatar
gb committed
133
            XSynchronize(priv->x11_display, synchronous);
134 135
            GST_VAAPI_DISPLAY_UNLOCK(display);
        }
gb's avatar
gb committed
136 137 138
    }
}

139
/* Check for display server extensions */
140
static void
141
check_extensions(GstVaapiDisplayX11 *display)
gb's avatar
gb committed
142
{
143 144 145
    GstVaapiDisplayX11Private * const priv =
        GST_VAAPI_DISPLAY_X11_PRIVATE(display);
    int evt_base, err_base;
gb's avatar
gb committed
146

147
#ifdef HAVE_XRANDR
148 149 150
    priv->use_xrandr = XRRQueryExtension(priv->x11_display,
        &evt_base, &err_base);
#endif
151 152 153 154
#ifdef HAVE_XRENDER
    priv->has_xrender = XRenderQueryExtension(priv->x11_display,
        &evt_base, &err_base);
#endif
gb's avatar
gb committed
155 156
}

157 158 159
static gboolean
gst_vaapi_display_x11_bind_display(GstVaapiDisplay *base_display,
    gpointer native_display)
160
{
161 162 163 164 165 166 167
    GstVaapiDisplayX11 * const display =
        GST_VAAPI_DISPLAY_X11_CAST(base_display);
    GstVaapiDisplayX11Private * const priv = &display->priv;

    priv->x11_display = native_display;
    priv->x11_screen = DefaultScreen(native_display);
    priv->use_foreign_display = TRUE;
168

169
    check_extensions(display);
170

171 172 173
    if (!set_display_name(display, XDisplayString(priv->x11_display)))
        return FALSE;
    return TRUE;
174 175
}

176
static gboolean
177 178
gst_vaapi_display_x11_open_display(GstVaapiDisplay *base_display,
    const gchar *name)
179
{
180 181 182 183 184 185 186 187
    GstVaapiDisplayX11 * const display =
        GST_VAAPI_DISPLAY_X11_CAST(base_display);
    GstVaapiDisplayX11Private * const priv = &display->priv;
    GstVaapiDisplayCache *cache;
    const GstVaapiDisplayInfo *info;

    cache = gst_vaapi_display_get_cache();
    g_return_val_if_fail(cache != NULL, FALSE);
188

189 190 191
    if (!set_display_name(display, name))
        return FALSE;

192
    info = gst_vaapi_display_cache_lookup_custom(cache, compare_display_name,
193
        priv->display_name, GST_VAAPI_DISPLAY_TYPES(display));
194 195 196 197 198
    if (info) {
        priv->x11_display = info->native_display;
        priv->use_foreign_display = TRUE;
    }
    else {
199
        priv->x11_display = XOpenDisplay(get_display_name(display));
200 201
        if (!priv->x11_display)
            return FALSE;
202
        priv->use_foreign_display = FALSE;
203
    }
204
    priv->x11_screen = DefaultScreen(priv->x11_display);
205

206
    check_extensions(display);
gb's avatar
gb committed
207
    return TRUE;
208 209 210 211 212 213
}

static void
gst_vaapi_display_x11_close_display(GstVaapiDisplay *display)
{
    GstVaapiDisplayX11Private * const priv =
214
        GST_VAAPI_DISPLAY_X11_PRIVATE(display);
215

216 217 218 219 220
    if (priv->pixmap_formats) {
        g_array_free(priv->pixmap_formats, TRUE);
        priv->pixmap_formats = NULL;
    }

221
    if (priv->x11_display) {
222
        if (!priv->use_foreign_display)
223
            XCloseDisplay(priv->x11_display);
224 225 226 227 228 229 230 231 232
        priv->x11_display = NULL;
    }

    if (priv->display_name) {
        g_free(priv->display_name);
        priv->display_name = NULL;
    }
}

233 234 235 236
static void
gst_vaapi_display_x11_sync(GstVaapiDisplay *display)
{
    GstVaapiDisplayX11Private * const priv =
237
        GST_VAAPI_DISPLAY_X11_PRIVATE(display);
238

gb's avatar
gb committed
239 240
    if (priv->x11_display) {
        GST_VAAPI_DISPLAY_LOCK(display);
241
        XSync(priv->x11_display, False);
gb's avatar
gb committed
242 243
        GST_VAAPI_DISPLAY_UNLOCK(display);
    }
244 245 246 247 248 249
}

static void
gst_vaapi_display_x11_flush(GstVaapiDisplay *display)
{
    GstVaapiDisplayX11Private * const priv =
250
        GST_VAAPI_DISPLAY_X11_PRIVATE(display);
251

gb's avatar
gb committed
252 253
    if (priv->x11_display) {
        GST_VAAPI_DISPLAY_LOCK(display);
254
        XFlush(priv->x11_display);
gb's avatar
gb committed
255 256
        GST_VAAPI_DISPLAY_UNLOCK(display);
    }
257 258
}

259 260 261 262 263
static gboolean
gst_vaapi_display_x11_get_display_info(
    GstVaapiDisplay     *display,
    GstVaapiDisplayInfo *info
)
264
{
265
    GstVaapiDisplayX11Private * const priv =
266
        GST_VAAPI_DISPLAY_X11_PRIVATE(display);
267 268 269 270 271 272 273
    GstVaapiDisplayCache *cache;
    const GstVaapiDisplayInfo *cached_info;

    /* Return any cached info even if child has its own VA display */
    cache = gst_vaapi_display_get_cache();
    if (!cache)
        return FALSE;
274
    cached_info = gst_vaapi_display_cache_lookup_by_native_display(
275
        cache, priv->x11_display, GST_VAAPI_DISPLAY_TYPES(display));
276 277 278 279 280 281 282 283 284 285 286 287
    if (cached_info) {
        *info = *cached_info;
        return TRUE;
    }

    /* Otherwise, create VA display if there is none already */
    info->native_display = priv->x11_display;
    info->display_name   = priv->display_name;
    if (!info->va_display) {
        info->va_display = vaGetDisplay(priv->x11_display);
        if (!info->va_display)
            return FALSE;
288
        info->display_type = GST_VAAPI_DISPLAY_TYPE_X11;
289 290
    }
    return TRUE;
291 292
}

gb's avatar
gb committed
293 294 295 296 297 298 299
static void
gst_vaapi_display_x11_get_size(
    GstVaapiDisplay *display,
    guint           *pwidth,
    guint           *pheight
)
{
300
    GstVaapiDisplayX11Private * const priv =
301
        GST_VAAPI_DISPLAY_X11_PRIVATE(display);
gb's avatar
gb committed
302 303 304 305 306 307 308 309 310 311 312

    if (!priv->x11_display)
        return;

    if (pwidth)
        *pwidth = DisplayWidth(priv->x11_display, priv->x11_screen);

    if (pheight)
        *pheight = DisplayHeight(priv->x11_display, priv->x11_screen);
}

313 314 315 316 317 318 319 320
static void
gst_vaapi_display_x11_get_size_mm(
    GstVaapiDisplay *display,
    guint           *pwidth,
    guint           *pheight
)
{
    GstVaapiDisplayX11Private * const priv =
321
        GST_VAAPI_DISPLAY_X11_PRIVATE(display);
322
    guint width_mm, height_mm;
323 324 325 326

    if (!priv->x11_display)
        return;

327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362
    width_mm  = DisplayWidthMM(priv->x11_display, priv->x11_screen);
    height_mm = DisplayHeightMM(priv->x11_display, priv->x11_screen);

#ifdef HAVE_XRANDR
    /* XXX: fix up physical size if the display is rotated */
    if (priv->use_xrandr) {
        XRRScreenConfiguration *xrr_config = NULL;
        XRRScreenSize *xrr_sizes;
        Window win;
        int num_xrr_sizes, size_id, screen;
        Rotation rotation;

        do {
            win    = DefaultRootWindow(priv->x11_display);
            screen = XRRRootToScreen(priv->x11_display, win);

            xrr_config = XRRGetScreenInfo(priv->x11_display, win);
            if (!xrr_config)
                break;

            size_id = XRRConfigCurrentConfiguration(xrr_config, &rotation);
            if (rotation == RR_Rotate_0 || rotation == RR_Rotate_180)
                break;

            xrr_sizes = XRRSizes(priv->x11_display, screen, &num_xrr_sizes);
            if (!xrr_sizes || size_id >= num_xrr_sizes)
                break;

            width_mm  = xrr_sizes[size_id].mheight;
            height_mm = xrr_sizes[size_id].mwidth;
        } while (0);
        if (xrr_config)
            XRRFreeScreenConfigInfo(xrr_config);
    }
#endif

363
    if (pwidth)
364
        *pwidth = width_mm;
365 366

    if (pheight)
367
        *pheight = height_mm;
368 369
}

370
void
gb's avatar
gb committed
371 372
gst_vaapi_display_x11_class_init(GstVaapiDisplayX11Class *klass)
{
373 374
    GstVaapiMiniObjectClass * const object_class =
        GST_VAAPI_MINI_OBJECT_CLASS(klass);
375
    GstVaapiDisplayClass * const dpy_class = GST_VAAPI_DISPLAY_CLASS(klass);
gb's avatar
gb committed
376

377
    gst_vaapi_display_class_init(&klass->parent_class);
378

379
    object_class->size          = sizeof(GstVaapiDisplayX11);
380
    dpy_class->display_types    = g_display_types;
381
    dpy_class->bind_display     = gst_vaapi_display_x11_bind_display;
382 383
    dpy_class->open_display     = gst_vaapi_display_x11_open_display;
    dpy_class->close_display    = gst_vaapi_display_x11_close_display;
384 385
    dpy_class->sync             = gst_vaapi_display_x11_sync;
    dpy_class->flush            = gst_vaapi_display_x11_flush;
386
    dpy_class->get_display      = gst_vaapi_display_x11_get_display_info;
gb's avatar
gb committed
387
    dpy_class->get_size         = gst_vaapi_display_x11_get_size;
388
    dpy_class->get_size_mm      = gst_vaapi_display_x11_get_size_mm;
gb's avatar
gb committed
389 390
}

391 392
static inline const GstVaapiDisplayClass *
gst_vaapi_display_x11_class(void)
gb's avatar
gb committed
393
{
394 395 396 397 398 399 400 401
    static GstVaapiDisplayX11Class g_class;
    static gsize g_class_init = FALSE;

    if (g_once_init_enter(&g_class_init)) {
        gst_vaapi_display_x11_class_init(&g_class);
        g_once_init_leave(&g_class_init, TRUE);
    }
    return GST_VAAPI_DISPLAY_CLASS(&g_class);
gb's avatar
gb committed
402 403
}

gb's avatar
gb committed
404 405 406 407 408 409 410 411 412 413
/**
 * gst_vaapi_display_x11_new:
 * @display_name: the X11 display name
 *
 * Opens an X11 #Display using @display_name and returns a newly
 * allocated #GstVaapiDisplay object. The X11 display will be cloed
 * when the reference count of the object reaches zero.
 *
 * Return value: a newly allocated #GstVaapiDisplay object
 */
414 415
GstVaapiDisplay *
gst_vaapi_display_x11_new(const gchar *display_name)
gb's avatar
gb committed
416
{
417 418
    return gst_vaapi_display_new(gst_vaapi_display_x11_class(),
        GST_VAAPI_DISPLAY_INIT_FROM_DISPLAY_NAME, (gpointer)display_name);
gb's avatar
gb committed
419 420
}

gb's avatar
gb committed
421 422 423 424 425 426 427 428 429 430 431
/**
 * gst_vaapi_display_x11_new_with_display:
 * @x11_display: an X11 #Display
 *
 * Creates a #GstVaapiDisplay based on the X11 @x11_display
 * display. The caller still owns the display and must call
 * XCloseDisplay() when all #GstVaapiDisplay references are
 * released. Doing so too early can yield undefined behaviour.
 *
 * Return value: a newly allocated #GstVaapiDisplay object
 */
432 433 434
GstVaapiDisplay *
gst_vaapi_display_x11_new_with_display(Display *x11_display)
{
435 436
    g_return_val_if_fail(x11_display, NULL);

437 438
    return gst_vaapi_display_new(gst_vaapi_display_x11_class(),
        GST_VAAPI_DISPLAY_INIT_FROM_NATIVE_DISPLAY, x11_display);
439 440
}

gb's avatar
gb committed
441 442 443 444 445 446 447 448 449 450
/**
 * gst_vaapi_display_x11_get_display:
 * @display: a #GstVaapiDisplayX11
 *
 * Returns the underlying X11 #Display that was created by
 * gst_vaapi_display_x11_new() or that was bound from
 * gst_vaapi_display_x11_new_with_display().
 *
 * Return value: the X11 #Display attached to @display
 */
451 452
Display *
gst_vaapi_display_x11_get_display(GstVaapiDisplayX11 *display)
gb's avatar
gb committed
453
{
454
    g_return_val_if_fail(GST_VAAPI_IS_DISPLAY_X11(display), NULL);
gb's avatar
gb committed
455

456
    return GST_VAAPI_DISPLAY_XDISPLAY(display);
gb's avatar
gb committed
457
}
458 459 460 461 462 463 464 465 466 467 468 469 470 471

/**
 * gst_vaapi_display_x11_get_screen:
 * @display: a #GstVaapiDisplayX11
 *
 * Returns the default X11 screen that was created by
 * gst_vaapi_display_x11_new() or that was bound from
 * gst_vaapi_display_x11_new_with_display().
 *
 * Return value: the X11 #Display attached to @display
 */
int
gst_vaapi_display_x11_get_screen(GstVaapiDisplayX11 *display)
{
472
    g_return_val_if_fail(GST_VAAPI_IS_DISPLAY_X11(display), -1);
473

474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491
    return GST_VAAPI_DISPLAY_XSCREEN(display);
}

/**
 * gst_vaapi_display_x11_set_synchronous:
 * @display: a #GstVaapiDisplayX11
 * @synchronous: boolean value that indicates whether to enable or
 *   disable synchronization
 *
 * If @synchronous is %TRUE, gst_vaapi_display_x11_set_synchronous()
 * turns on synchronous behaviour on the underlying X11
 * display. Otherwise, synchronous behaviour is disabled if
 * @synchronous is %FALSE.
 */
void
gst_vaapi_display_x11_set_synchronous(GstVaapiDisplayX11 *display,
    gboolean synchronous)
{
492
    g_return_if_fail(GST_VAAPI_IS_DISPLAY_X11(display));
493 494

    set_synchronous(display, synchronous);
495
}
496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605

typedef struct _GstVaapiPixmapFormatX11 GstVaapiPixmapFormatX11;
struct _GstVaapiPixmapFormatX11 {
    GstVideoFormat      format;
    gint                depth;
    gint                bpp;
};

static GstVideoFormat
pix_fmt_to_video_format(gint depth, gint bpp)
{
    GstVideoFormat format = GST_VIDEO_FORMAT_UNKNOWN;

    switch (bpp) {
    case 16:
        if (depth == 15)
            format = GST_VIDEO_FORMAT_RGB15;
        else if (depth == 16)
            format = GST_VIDEO_FORMAT_RGB16;
        break;
    case 24:
        if (depth == 24)
            format = GST_VIDEO_FORMAT_RGB;
        break;
    case 32:
        if (depth == 24 || depth == 32)
            format = GST_VIDEO_FORMAT_xRGB;
        break;
    }
    return format;
}

static gboolean
ensure_pix_fmts(GstVaapiDisplayX11 *display)
{
    GstVaapiDisplayX11Private * const priv =
        GST_VAAPI_DISPLAY_X11_PRIVATE(display);
    XPixmapFormatValues *pix_fmts;
    int i, n, num_pix_fmts;

    if (priv->pixmap_formats)
        return TRUE;

    GST_VAAPI_DISPLAY_LOCK(display);
    pix_fmts = XListPixmapFormats(GST_VAAPI_DISPLAY_XDISPLAY(display),
        &num_pix_fmts);
    GST_VAAPI_DISPLAY_UNLOCK(display);
    if (!pix_fmts)
        return FALSE;

    priv->pixmap_formats = g_array_sized_new(FALSE, FALSE,
        sizeof(GstVaapiPixmapFormatX11), num_pix_fmts);
    if (!priv->pixmap_formats) {
        XFree(pix_fmts);
        return FALSE;
    }

    for (i = 0, n = 0; i < num_pix_fmts; i++) {
        GstVaapiPixmapFormatX11 * const pix_fmt =
            &g_array_index(priv->pixmap_formats, GstVaapiPixmapFormatX11, n);

        pix_fmt->depth  = pix_fmts[i].depth;
        pix_fmt->bpp    = pix_fmts[i].bits_per_pixel;
        pix_fmt->format = pix_fmt_to_video_format(pix_fmt->depth, pix_fmt->bpp);
        if (pix_fmt->format != GST_VIDEO_FORMAT_UNKNOWN)
            n++;
    }
    priv->pixmap_formats->len = n;
    return TRUE;
}

/* Determine the GstVideoFormat based on a supported Pixmap depth */
GstVideoFormat
gst_vaapi_display_x11_get_pixmap_format(GstVaapiDisplayX11 *display,
    guint depth)
{
    if (ensure_pix_fmts(display)) {
        GstVaapiDisplayX11Private * const priv =
            GST_VAAPI_DISPLAY_X11_PRIVATE(display);
        guint i;

        for (i = 0; i < priv->pixmap_formats->len; i++) {
            GstVaapiPixmapFormatX11 * const pix_fmt = &g_array_index(
                priv->pixmap_formats, GstVaapiPixmapFormatX11, i);
            if (pix_fmt->depth == depth)
                return pix_fmt->format;
        }
    }
    return GST_VIDEO_FORMAT_UNKNOWN;
}

/* Determine the Pixmap depth based on a GstVideoFormat */
guint
gst_vaapi_display_x11_get_pixmap_depth(GstVaapiDisplayX11 *display,
    GstVideoFormat format)
{
    if (ensure_pix_fmts(display)) {
        GstVaapiDisplayX11Private * const priv =
            GST_VAAPI_DISPLAY_X11_PRIVATE(display);
        guint i;

        for (i = 0; i < priv->pixmap_formats->len; i++) {
            GstVaapiPixmapFormatX11 * const pix_fmt = &g_array_index(
                priv->pixmap_formats, GstVaapiPixmapFormatX11, i);
            if (pix_fmt->format == format)
                return pix_fmt->depth;
        }
    }
    return 0;
}