src/gallium/state_trackers/egl/x11/native_ximage.c

   1 /*
   2  * Mesa 3-D graphics library
   3  * Version:  7.8
   4  *
   5  * Copyright (C) 2009-2010 Chia-I Wu <olv@0xlab.org>
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a
   8  * copy of this software and associated documentation files (the "Software"),
   9  * to deal in the Software without restriction, including without limitation
  10  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  11  * and/or sell copies of the Software, and to permit persons to whom the
  12  * Software is furnished to do so, subject to the following conditions:
  13  *
  14  * The above copyright notice and this permission notice shall be included
  15  * in all copies or substantial portions of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  20  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  21  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  22  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  23  * DEALINGS IN THE SOFTWARE.
  24  */
  25
  26 #include <X11/Xlib.h>
  27 #include <X11/Xutil.h>
  28 #include "util/u_memory.h"
  29 #include "util/u_math.h"
  30 #include "util/u_format.h"
  31 #include "pipe/p_compiler.h"
  32 #include "util/u_inlines.h"
  33 #include "state_tracker/xlib_sw_winsys.h"
  34 #include "util/u_debug.h"
  35 #include "egllog.h"
  36
  37 #include "common/native_helper.h"
  38 #include "native_x11.h"
  39 #include "x11_screen.h"
  40
  41 enum ximage_surface_type {
  42    XIMAGE_SURFACE_TYPE_WINDOW,
  43    XIMAGE_SURFACE_TYPE_PIXMAP,
  44 };
  45
  46 struct ximage_display {
  47    struct native_display base;
  48    Display *dpy;
  49    boolean own_dpy;
  50
  51    struct native_event_handler *event_handler;
  52
  53    struct x11_screen *xscr;
  54    int xscr_number;
  55
  56    struct ximage_config *configs;
  57    int num_configs;
  58 };
  59
  60 struct ximage_surface {
  61    struct native_surface base;
  62    Drawable drawable;
  63    enum ximage_surface_type type;
  64    enum pipe_format color_format;
  65    XVisualInfo visual;
  66    struct ximage_display *xdpy;
  67
  68    unsigned int server_stamp;
  69    unsigned int client_stamp;
  70
  71    struct resource_surface *rsurf;
  72    struct xlib_drawable xdraw;
  73 };
  74
  75 struct ximage_config {
  76    struct native_config base;
  77    const XVisualInfo *visual;
  78 };
  79
  80 static INLINE struct ximage_display *
  81 ximage_display(const struct native_display *ndpy)
  82 {
  83    return (struct ximage_display *) ndpy;
  84 }
  85
  86 static INLINE struct ximage_surface *
  87 ximage_surface(const struct native_surface *nsurf)
  88 {
  89    return (struct ximage_surface *) nsurf;
  90 }
  91
  92 static INLINE struct ximage_config *
  93 ximage_config(const struct native_config *nconf)
  94 {
  95    return (struct ximage_config *) nconf;
  96 }
  97
  98 /**
  99  * Update the geometry of the surface.  This is a slow functions.
 100  */
 101 static void
 102 ximage_surface_update_geometry(struct native_surface *nsurf)
 103 {
 104    struct ximage_surface *xsurf = ximage_surface(nsurf);
 105    Status ok;
 106    Window root;
 107    int x, y;
 108    unsigned int w, h, border, depth;
 109
 110    ok = XGetGeometry(xsurf->xdpy->dpy, xsurf->drawable,
 111          &root, &x, &y, &w, &h, &border, &depth);
 112    if (ok && resource_surface_set_size(xsurf->rsurf, w, h))
 113       xsurf->server_stamp++;
 114 }
 115
 116 /**
 117  * Update the buffers of the surface.
 118  */
 119 static boolean
 120 ximage_surface_update_buffers(struct native_surface *nsurf, uint buffer_mask)
 121 {
 122    struct ximage_surface *xsurf = ximage_surface(nsurf);
 123
 124    if (xsurf->client_stamp != xsurf->server_stamp) {
 125       ximage_surface_update_geometry(&xsurf->base);
 126       xsurf->client_stamp = xsurf->server_stamp;
 127    }
 128
 129    return resource_surface_add_resources(xsurf->rsurf, buffer_mask);
 130 }
 131
 132 /**
 133  * Emulate an invalidate event.
 134  */
 135 static void
 136 ximage_surface_invalidate(struct native_surface *nsurf)
 137 {
 138    struct ximage_surface *xsurf = ximage_surface(nsurf);
 139    struct ximage_display *xdpy = xsurf->xdpy;
 140
 141    xsurf->server_stamp++;
 142    xdpy->event_handler->invalid_surface(&xdpy->base,
 143          &xsurf->base, xsurf->server_stamp);
 144 }
 145
 146 static boolean
 147 ximage_surface_flush_frontbuffer(struct native_surface *nsurf)
 148 {
 149    struct ximage_surface *xsurf = ximage_surface(nsurf);
 150    boolean ret;
 151
 152    ret = resource_surface_present(xsurf->rsurf,
 153          NATIVE_ATTACHMENT_FRONT_LEFT, (void *) &xsurf->xdraw);
 154    /* force buffers to be updated in next validation call */
 155    ximage_surface_invalidate(&xsurf->base);
 156
 157    return ret;
 158 }
 159
 160 static boolean
 161 ximage_surface_swap_buffers(struct native_surface *nsurf)
 162 {
 163    struct ximage_surface *xsurf = ximage_surface(nsurf);
 164    boolean ret;
 165
 166    ret = resource_surface_present(xsurf->rsurf,
 167          NATIVE_ATTACHMENT_BACK_LEFT, (void *) &xsurf->xdraw);
 168
 169    resource_surface_swap_buffers(xsurf->rsurf,
 170          NATIVE_ATTACHMENT_FRONT_LEFT, NATIVE_ATTACHMENT_BACK_LEFT, TRUE);
 171    /* the front/back buffers have been swapped */
 172    ximage_surface_invalidate(&xsurf->base);
 173
 174    return ret;
 175 }
 176
 177 static boolean
 178 ximage_surface_present(struct native_surface *nsurf,
 179                        enum native_attachment natt,
 180                        boolean preserve,
 181                        uint swap_interval)
 182 {
 183    boolean ret;
 184
 185    if (preserve || swap_interval)
 186       return FALSE;
 187
 188    switch (natt) {
 189    case NATIVE_ATTACHMENT_FRONT_LEFT:
 190       ret = ximage_surface_flush_frontbuffer(nsurf);
 191       break;
 192    case NATIVE_ATTACHMENT_BACK_LEFT:
 193       ret = ximage_surface_swap_buffers(nsurf);
 194       break;
 195    default:
 196       ret = FALSE;
 197       break;
 198    }
 199
 200    return ret;
 201 }
 202
 203 static boolean
 204 ximage_surface_validate(struct native_surface *nsurf, uint attachment_mask,
 205                         unsigned int *seq_num, struct pipe_resource **textures,
 206                         int *width, int *height)
 207 {
 208    struct ximage_surface *xsurf = ximage_surface(nsurf);
 209    uint w, h;
 210
 211    if (!ximage_surface_update_buffers(&xsurf->base, attachment_mask))
 212       return FALSE;
 213
 214    if (seq_num)
 215       *seq_num = xsurf->client_stamp;
 216
 217    if (textures)
 218       resource_surface_get_resources(xsurf->rsurf, textures, attachment_mask);
 219
 220    resource_surface_get_size(xsurf->rsurf, &w, &h);
 221    if (width)
 222       *width = w;
 223    if (height)
 224       *height = h;
 225
 226    return TRUE;
 227 }
 228
 229 static void
 230 ximage_surface_wait(struct native_surface *nsurf)
 231 {
 232    struct ximage_surface *xsurf = ximage_surface(nsurf);
 233    XSync(xsurf->xdpy->dpy, FALSE);
 234    /* TODO XGetImage and update the front texture */
 235 }
 236
 237 static void
 238 ximage_surface_destroy(struct native_surface *nsurf)
 239 {
 240    struct ximage_surface *xsurf = ximage_surface(nsurf);
 241
 242    resource_surface_destroy(xsurf->rsurf);
 243    FREE(xsurf);
 244 }
 245
 246 static struct ximage_surface *
 247 ximage_display_create_surface(struct native_display *ndpy,
 248                               enum ximage_surface_type type,
 249                               Drawable drawable,
 250                               const struct native_config *nconf)
 251 {
 252    struct ximage_display *xdpy = ximage_display(ndpy);
 253    struct ximage_config *xconf = ximage_config(nconf);
 254    struct ximage_surface *xsurf;
 255
 256    xsurf = CALLOC_STRUCT(ximage_surface);
 257    if (!xsurf)
 258       return NULL;
 259
 260    xsurf->xdpy = xdpy;
 261    xsurf->type = type;
 262    xsurf->color_format = xconf->base.color_format;
 263    xsurf->drawable = drawable;
 264
 265    xsurf->rsurf = resource_surface_create(xdpy->base.screen,
 266          xsurf->color_format,
 267          PIPE_BIND_RENDER_TARGET |
 268          PIPE_BIND_SAMPLER_VIEW |
 269          PIPE_BIND_DISPLAY_TARGET |
 270          PIPE_BIND_SCANOUT);
 271    if (!xsurf->rsurf) {
 272       FREE(xsurf);
 273       return NULL;
 274    }
 275
 276    xsurf->drawable = drawable;
 277    xsurf->visual = *xconf->visual;
 278    /* initialize the geometry */
 279    ximage_surface_update_geometry(&xsurf->base);
 280
 281    xsurf->xdraw.visual = xsurf->visual.visual;
 282    xsurf->xdraw.depth = xsurf->visual.depth;
 283    xsurf->xdraw.drawable = xsurf->drawable;
 284
 285    xsurf->base.destroy = ximage_surface_destroy;
 286    xsurf->base.present = ximage_surface_present;
 287    xsurf->base.validate = ximage_surface_validate;
 288    xsurf->base.wait = ximage_surface_wait;
 289
 290    return xsurf;
 291 }
 292
 293 static struct native_surface *
 294 ximage_display_create_window_surface(struct native_display *ndpy,
 295                                      EGLNativeWindowType win,
 296                                      const struct native_config *nconf)
 297 {
 298    struct ximage_surface *xsurf;
 299
 300    xsurf = ximage_display_create_surface(ndpy, XIMAGE_SURFACE_TYPE_WINDOW,
 301          (Drawable) win, nconf);
 302    return (xsurf) ? &xsurf->base : NULL;
 303 }
 304
 305 static struct native_surface *
 306 ximage_display_create_pixmap_surface(struct native_display *ndpy,
 307                                      EGLNativePixmapType pix,
 308                                      const struct native_config *nconf)
 309 {
 310    struct ximage_surface *xsurf;
 311
 312    xsurf = ximage_display_create_surface(ndpy, XIMAGE_SURFACE_TYPE_PIXMAP,
 313          (Drawable) pix, nconf);
 314    return (xsurf) ? &xsurf->base : NULL;
 315 }
 316
 317 static enum pipe_format
 318 choose_format(const XVisualInfo *vinfo)
 319 {
 320    enum pipe_format fmt;
 321    /* TODO elaborate the formats */
 322    switch (vinfo->depth) {
 323    case 32:
 324       fmt = PIPE_FORMAT_B8G8R8A8_UNORM;
 325       break;
 326    case 24:
 327       fmt = PIPE_FORMAT_B8G8R8X8_UNORM;
 328       break;
 329    case 16:
 330       fmt = PIPE_FORMAT_B5G6R5_UNORM;
 331       break;
 332    default:
 333       fmt = PIPE_FORMAT_NONE;
 334       break;
 335    }
 336
 337    return fmt;
 338 }
 339
 340 static const struct native_config **
 341 ximage_display_get_configs(struct native_display *ndpy, int *num_configs)
 342 {
 343    struct ximage_display *xdpy = ximage_display(ndpy);
 344    const struct native_config **configs;
 345    int i;
 346
 347    /* first time */
 348    if (!xdpy->configs) {
 349       const XVisualInfo *visuals;
 350       int num_visuals, count;
 351
 352       visuals = x11_screen_get_visuals(xdpy->xscr, &num_visuals);
 353       if (!visuals)
 354          return NULL;
 355
 356       /*
 357        * Create two configs for each visual.
 358        * One with depth/stencil buffer; one without
 359        */
 360       xdpy->configs = CALLOC(num_visuals * 2, sizeof(*xdpy->configs));
 361       if (!xdpy->configs)
 362          return NULL;
 363
 364       count = 0;
 365       for (i = 0; i < num_visuals; i++) {
 366          struct ximage_config *xconf = &xdpy->configs[count];
 367
 368          xconf->visual = &visuals[i];
 369          xconf->base.color_format = choose_format(xconf->visual);
 370          if (xconf->base.color_format == PIPE_FORMAT_NONE)
 371             continue;
 372
 373          xconf->base.buffer_mask =
 374             (1 << NATIVE_ATTACHMENT_FRONT_LEFT) |
 375             (1 << NATIVE_ATTACHMENT_BACK_LEFT);
 376
 377          xconf->base.window_bit = TRUE;
 378          xconf->base.pixmap_bit = TRUE;
 379
 380          xconf->base.native_visual_id = xconf->visual->visualid;
 381 #if defined(__cplusplus) || defined(c_plusplus)
 382          xconf->base.native_visual_type = xconf->visual->c_class;
 383 #else
 384          xconf->base.native_visual_type = xconf->visual->class;
 385 #endif
 386
 387          xconf->base.slow_config = TRUE;
 388
 389          count++;
 390       }
 391
 392       xdpy->num_configs = count;
 393    }
 394
 395    configs = MALLOC(xdpy->num_configs * sizeof(*configs));
 396    if (configs) {
 397       for (i = 0; i < xdpy->num_configs; i++)
 398          configs[i] = (const struct native_config *) &xdpy->configs[i];
 399       if (num_configs)
 400          *num_configs = xdpy->num_configs;
 401    }
 402    return configs;
 403 }
 404
 405 static boolean
 406 ximage_display_is_pixmap_supported(struct native_display *ndpy,
 407                                    EGLNativePixmapType pix,
 408                                    const struct native_config *nconf)
 409 {
 410    struct ximage_display *xdpy = ximage_display(ndpy);
 411    enum pipe_format fmt;
 412    uint depth;
 413
 414    depth = x11_drawable_get_depth(xdpy->xscr, (Drawable) pix);
 415    switch (depth) {
 416    case 32:
 417       fmt = PIPE_FORMAT_B8G8R8A8_UNORM;
 418       break;
 419    case 24:
 420       fmt = PIPE_FORMAT_B8G8R8X8_UNORM;
 421       break;
 422    case 16:
 423       fmt = PIPE_FORMAT_B5G6R5_UNORM;
 424       break;
 425    default:
 426       fmt = PIPE_FORMAT_NONE;
 427       break;
 428    }
 429
 430    return (fmt == nconf->color_format);
 431 }
 432
 433 static int
 434 ximage_display_get_param(struct native_display *ndpy,
 435                          enum native_param_type param)
 436 {
 437    int val;
 438
 439    switch (param) {
 440    case NATIVE_PARAM_USE_NATIVE_BUFFER:
 441       /* private buffers are allocated */
 442       val = FALSE;
 443       break;
 444    case NATIVE_PARAM_PRESERVE_BUFFER:
 445    case NATIVE_PARAM_MAX_SWAP_INTERVAL:
 446    default:
 447       val = 0;
 448       break;
 449    }
 450
 451    return val;
 452 }
 453
 454 static void
 455 ximage_display_destroy(struct native_display *ndpy)
 456 {
 457    struct ximage_display *xdpy = ximage_display(ndpy);
 458
 459    if (xdpy->configs)
 460       FREE(xdpy->configs);
 461
 462    xdpy->base.screen->destroy(xdpy->base.screen);
 463
 464    x11_screen_destroy(xdpy->xscr);
 465    if (xdpy->own_dpy)
 466       XCloseDisplay(xdpy->dpy);
 467    FREE(xdpy);
 468 }
 469
 470 struct native_display *
 471 x11_create_ximage_display(Display *dpy,
 472                           struct native_event_handler *event_handler,
 473                           void *user_data)
 474 {
 475    struct ximage_display *xdpy;
 476    struct sw_winsys *winsys = NULL;
 477
 478    xdpy = CALLOC_STRUCT(ximage_display);
 479    if (!xdpy)
 480       return NULL;
 481
 482    xdpy->dpy = dpy;
 483    if (!xdpy->dpy) {
 484       xdpy->dpy = XOpenDisplay(NULL);
 485       if (!xdpy->dpy) {
 486          FREE(xdpy);
 487          return NULL;
 488       }
 489       xdpy->own_dpy = TRUE;
 490    }
 491
 492    xdpy->event_handler = event_handler;
 493    xdpy->base.user_data = user_data;
 494
 495    xdpy->xscr_number = DefaultScreen(xdpy->dpy);
 496    xdpy->xscr = x11_screen_create(xdpy->dpy, xdpy->xscr_number);
 497    if (!xdpy->xscr)
 498       goto fail;
 499
 500    winsys = xlib_create_sw_winsys(xdpy->dpy);
 501    if (!winsys)
 502       goto fail;
 503
 504    xdpy->base.screen =
 505       xdpy->event_handler->new_sw_screen(&xdpy->base, winsys);
 506    if (!xdpy->base.screen)
 507       goto fail;
 508
 509    xdpy->base.destroy = ximage_display_destroy;
 510    xdpy->base.get_param = ximage_display_get_param;
 511
 512    xdpy->base.get_configs = ximage_display_get_configs;
 513    xdpy->base.is_pixmap_supported = ximage_display_is_pixmap_supported;
 514    xdpy->base.create_window_surface = ximage_display_create_window_surface;
 515    xdpy->base.create_pixmap_surface = ximage_display_create_pixmap_surface;
 516
 517    return &xdpy->base;
 518
 519 fail:
 520    if (winsys && winsys->destroy)
 521       winsys->destroy(winsys);
 522    if (xdpy->xscr)
 523       x11_screen_destroy(xdpy->xscr);
 524    if (xdpy->dpy && xdpy->own_dpy)
 525       XCloseDisplay(xdpy->dpy);
 526    FREE(xdpy);
 527    return NULL;
 528 }