xm_api.c revision d405ba3151de9585a310b7e2ebcae09302c0dbe4
1/*
2 * Mesa 3-D graphics library
3 * Version:  7.1
4 *
5 * Copyright (C) 1999-2007  Brian Paul   All Rights Reserved.
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
18 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
20 * BRIAN PAUL BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
21 * AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
22 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23 */
24
25/**
26 * \file xm_api.c
27 *
28 * All the XMesa* API functions.
29 *
30 *
31 * NOTES:
32 *
33 * The window coordinate system origin (0,0) is in the lower-left corner
34 * of the window.  X11's window coordinate origin is in the upper-left
35 * corner of the window.  Therefore, most drawing functions in this
36 * file have to flip Y coordinates.
37 *
38 * Define USE_XSHM in the Makefile with -DUSE_XSHM if you want to compile
39 * in support for the MIT Shared Memory extension.  If enabled, when you
40 * use an Ximage for the back buffer in double buffered mode, the "swap"
41 * operation will be faster.  You must also link with -lXext.
42 *
43 * Byte swapping:  If the Mesa host and the X display use a different
44 * byte order then there's some trickiness to be aware of when using
45 * XImages.  The byte ordering used for the XImage is that of the X
46 * display, not the Mesa host.
47 * The color-to-pixel encoding for True/DirectColor must be done
48 * according to the display's visual red_mask, green_mask, and blue_mask.
49 * If XPutPixel is used to put a pixel into an XImage then XPutPixel will
50 * do byte swapping if needed.  If one wants to directly "poke" the pixel
51 * into the XImage's buffer then the pixel must be byte swapped first.
52 *
53 */
54
55#ifdef __CYGWIN__
56#undef WIN32
57#undef __WIN32__
58#endif
59
60#include "xm_api.h"
61#include "main/context.h"
62#include "main/framebuffer.h"
63
64#include "state_tracker/st_public.h"
65#include "state_tracker/st_context.h"
66#include "pipe/p_defines.h"
67#include "pipe/p_screen.h"
68#include "pipe/p_context.h"
69
70#include "xm_winsys.h"
71#include <GL/glx.h>
72
73
74/* Driver interface routines, set up by xlib backend on library
75 * _init().  These are global in the same way that function names are
76 * global.
77 */
78static struct xm_driver driver;
79
80void xmesa_set_driver( const struct xm_driver *templ )
81{
82   driver = *templ;
83}
84
85/**
86 * Global X driver lock
87 */
88pipe_mutex _xmesa_lock;
89
90
91
92/**********************************************************************/
93/*****                     X Utility Functions                    *****/
94/**********************************************************************/
95
96
97/**
98 * Return the host's byte order as LSBFirst or MSBFirst ala X.
99 */
100static int host_byte_order( void )
101{
102   int i = 1;
103   char *cptr = (char *) &i;
104   return (*cptr==1) ? LSBFirst : MSBFirst;
105}
106
107
108/**
109 * Check if the X Shared Memory extension is available.
110 * Return:  0 = not available
111 *          1 = shared XImage support available
112 *          2 = shared Pixmap support available also
113 */
114int xmesa_check_for_xshm( Display *display )
115{
116#if defined(USE_XSHM)
117   int major, minor, ignore;
118   Bool pixmaps;
119
120   if (getenv("SP_NO_RAST"))
121      return 0;
122
123   if (getenv("MESA_NOSHM")) {
124      return 0;
125   }
126
127   if (XQueryExtension( display, "MIT-SHM", &ignore, &ignore, &ignore )) {
128      if (XShmQueryVersion( display, &major, &minor, &pixmaps )==True) {
129	 return (pixmaps==True) ? 2 : 1;
130      }
131      else {
132	 return 0;
133      }
134   }
135   else {
136      return 0;
137   }
138#else
139   /* No  XSHM support */
140   return 0;
141#endif
142}
143
144
145/**
146 * Return the true number of bits per pixel for XImages.
147 * For example, if we request a 24-bit deep visual we may actually need/get
148 * 32bpp XImages.  This function returns the appropriate bpp.
149 * Input:  dpy - the X display
150 *         visinfo - desribes the visual to be used for XImages
151 * Return:  true number of bits per pixel for XImages
152 */
153static int
154bits_per_pixel( XMesaVisual xmv )
155{
156   Display *dpy = xmv->display;
157   XVisualInfo * visinfo = xmv->visinfo;
158   XImage *img;
159   int bitsPerPixel;
160   /* Create a temporary XImage */
161   img = XCreateImage( dpy, visinfo->visual, visinfo->depth,
162		       ZPixmap, 0,           /*format, offset*/
163		       (char*) MALLOC(8),    /*data*/
164		       1, 1,                 /*width, height*/
165		       32,                   /*bitmap_pad*/
166		       0                     /*bytes_per_line*/
167                     );
168   assert(img);
169   /* grab the bits/pixel value */
170   bitsPerPixel = img->bits_per_pixel;
171   /* free the XImage */
172   _mesa_free( img->data );
173   img->data = NULL;
174   XDestroyImage( img );
175   return bitsPerPixel;
176}
177
178
179
180/*
181 * Determine if a given X window ID is valid (window exists).
182 * Do this by calling XGetWindowAttributes() for the window and
183 * checking if we catch an X error.
184 * Input:  dpy - the display
185 *         win - the window to check for existance
186 * Return:  GL_TRUE - window exists
187 *          GL_FALSE - window doesn't exist
188 */
189static GLboolean WindowExistsFlag;
190
191static int window_exists_err_handler( Display* dpy, XErrorEvent* xerr )
192{
193   (void) dpy;
194   if (xerr->error_code == BadWindow) {
195      WindowExistsFlag = GL_FALSE;
196   }
197   return 0;
198}
199
200static GLboolean window_exists( Display *dpy, Window win )
201{
202   XWindowAttributes wa;
203   int (*old_handler)( Display*, XErrorEvent* );
204   WindowExistsFlag = GL_TRUE;
205   old_handler = XSetErrorHandler(window_exists_err_handler);
206   XGetWindowAttributes( dpy, win, &wa ); /* dummy request */
207   XSetErrorHandler(old_handler);
208   return WindowExistsFlag;
209}
210
211static Status
212get_drawable_size( Display *dpy, Drawable d, uint *width, uint *height )
213{
214   Window root;
215   Status stat;
216   int xpos, ypos;
217   unsigned int w, h, bw, depth;
218   stat = XGetGeometry(dpy, d, &root, &xpos, &ypos, &w, &h, &bw, &depth);
219   *width = w;
220   *height = h;
221   return stat;
222}
223
224
225/**
226 * Return the size of the window (or pixmap) that corresponds to the
227 * given XMesaBuffer.
228 * \param width  returns width in pixels
229 * \param height  returns height in pixels
230 */
231static void
232xmesa_get_window_size(Display *dpy, XMesaBuffer b,
233                      GLuint *width, GLuint *height)
234{
235   Status stat;
236
237   pipe_mutex_lock(_xmesa_lock);
238   XSync(b->xm_visual->display, 0); /* added for Chromium */
239   stat = get_drawable_size(dpy, b->drawable, width, height);
240   pipe_mutex_unlock(_xmesa_lock);
241
242   if (!stat) {
243      /* probably querying a window that's recently been destroyed */
244      _mesa_warning(NULL, "XGetGeometry failed!\n");
245      *width = *height = 1;
246   }
247}
248
249#define GET_REDMASK(__v)        __v->mesa_visual.redMask
250#define GET_GREENMASK(__v)      __v->mesa_visual.greenMask
251#define GET_BLUEMASK(__v)       __v->mesa_visual.blueMask
252
253
254/**
255 * Choose the pixel format for the given visual.
256 * This will tell the gallium driver how to pack pixel data into
257 * drawing surfaces.
258 */
259static GLuint
260choose_pixel_format(XMesaVisual v)
261{
262   boolean native_byte_order = (host_byte_order() ==
263                                ImageByteOrder(v->display));
264
265   if (   GET_REDMASK(v)   == 0x0000ff
266       && GET_GREENMASK(v) == 0x00ff00
267       && GET_BLUEMASK(v)  == 0xff0000
268       && v->BitsPerPixel == 32) {
269      if (native_byte_order) {
270         /* no byteswapping needed */
271         return 0 /* PIXEL_FORMAT_U_A8_B8_G8_R8 */;
272      }
273      else {
274         return PIPE_FORMAT_R8G8B8A8_UNORM;
275      }
276   }
277   else if (   GET_REDMASK(v)   == 0xff0000
278            && GET_GREENMASK(v) == 0x00ff00
279            && GET_BLUEMASK(v)  == 0x0000ff
280            && v->BitsPerPixel == 32) {
281      if (native_byte_order) {
282         /* no byteswapping needed */
283         return PIPE_FORMAT_A8R8G8B8_UNORM;
284      }
285      else {
286         return PIPE_FORMAT_B8G8R8A8_UNORM;
287      }
288   }
289   else if (   GET_REDMASK(v)   == 0xf800
290            && GET_GREENMASK(v) == 0x07e0
291            && GET_BLUEMASK(v)  == 0x001f
292            && native_byte_order
293            && v->BitsPerPixel == 16) {
294      /* 5-6-5 RGB */
295      return PIPE_FORMAT_R5G6B5_UNORM;
296   }
297
298   assert(0);
299   return 0;
300}
301
302
303
304/**********************************************************************/
305/*****                Linked list of XMesaBuffers                 *****/
306/**********************************************************************/
307
308XMesaBuffer XMesaBufferList = NULL;
309
310
311/**
312 * Allocate a new XMesaBuffer object which corresponds to the given drawable.
313 * Note that XMesaBuffer is derived from GLframebuffer.
314 * The new XMesaBuffer will not have any size (Width=Height=0).
315 *
316 * \param d  the corresponding X drawable (window or pixmap)
317 * \param type  either WINDOW, PIXMAP or PBUFFER, describing d
318 * \param vis  the buffer's visual
319 * \param cmap  the window's colormap, if known.
320 * \return new XMesaBuffer or NULL if any problem
321 */
322static XMesaBuffer
323create_xmesa_buffer(Drawable d, BufferType type,
324                    XMesaVisual vis, Colormap cmap)
325{
326   XMesaBuffer b;
327   GLframebuffer *fb;
328   enum pipe_format colorFormat, depthFormat, stencilFormat;
329   uint width, height;
330
331   ASSERT(type == WINDOW || type == PIXMAP || type == PBUFFER);
332
333   b = (XMesaBuffer) CALLOC_STRUCT(xmesa_buffer);
334   if (!b)
335      return NULL;
336
337   b->drawable = d;
338
339   b->xm_visual = vis;
340   b->type = type;
341   b->cmap = cmap;
342
343   /* determine PIPE_FORMATs for buffers */
344   colorFormat = choose_pixel_format(vis);
345
346   if (vis->mesa_visual.depthBits == 0)
347      depthFormat = PIPE_FORMAT_NONE;
348#ifdef GALLIUM_CELL /* XXX temporary for Cell! */
349   else
350      depthFormat = PIPE_FORMAT_S8Z24_UNORM;
351#else
352   else if (vis->mesa_visual.depthBits <= 16)
353      depthFormat = PIPE_FORMAT_Z16_UNORM;
354   else if (vis->mesa_visual.depthBits <= 24)
355      depthFormat = PIPE_FORMAT_S8Z24_UNORM;
356   else
357      depthFormat = PIPE_FORMAT_Z32_UNORM;
358#endif
359
360   if (vis->mesa_visual.stencilBits == 8) {
361      if (depthFormat == PIPE_FORMAT_S8Z24_UNORM)
362         stencilFormat = depthFormat;
363      else
364         stencilFormat = PIPE_FORMAT_S8_UNORM;
365   }
366   else {
367      /* no stencil */
368      stencilFormat = PIPE_FORMAT_NONE;
369      if (depthFormat == PIPE_FORMAT_S8Z24_UNORM) {
370         /* use 24-bit Z, undefined stencil channel */
371         depthFormat = PIPE_FORMAT_X8Z24_UNORM;
372      }
373   }
374
375
376   get_drawable_size(vis->display, d, &width, &height);
377
378   /*
379    * Create framebuffer, but we'll plug in our own renderbuffers below.
380    */
381   b->stfb = st_create_framebuffer(&vis->mesa_visual,
382                                   colorFormat, depthFormat, stencilFormat,
383                                   width, height,
384                                   (void *) b);
385   fb = &b->stfb->Base;
386
387   /*
388    * Create scratch XImage for xmesa_display_surface()
389    */
390   b->tempImage = XCreateImage(vis->display,
391                               vis->visinfo->visual,
392                               vis->visinfo->depth,
393                               ZPixmap, 0,   /* format, offset */
394                               NULL,         /* data */
395                               0, 0,         /* size */
396                               32,           /* bitmap_pad */
397                               0);           /* bytes_per_line */
398
399   /* GLX_EXT_texture_from_pixmap */
400   b->TextureTarget = 0;
401   b->TextureFormat = GLX_TEXTURE_FORMAT_NONE_EXT;
402   b->TextureMipmap = 0;
403
404   /* insert buffer into linked list */
405   b->Next = XMesaBufferList;
406   XMesaBufferList = b;
407
408   return b;
409}
410
411
412/**
413 * Find an XMesaBuffer by matching X display and colormap but NOT matching
414 * the notThis buffer.
415 */
416XMesaBuffer
417xmesa_find_buffer(Display *dpy, Colormap cmap, XMesaBuffer notThis)
418{
419   XMesaBuffer b;
420   for (b = XMesaBufferList; b; b = b->Next) {
421      if (b->xm_visual->display == dpy &&
422          b->cmap == cmap &&
423          b != notThis) {
424         return b;
425      }
426   }
427   return NULL;
428}
429
430
431/**
432 * Remove buffer from linked list, delete if no longer referenced.
433 */
434static void
435xmesa_free_buffer(XMesaBuffer buffer)
436{
437   XMesaBuffer prev = NULL, b;
438
439   for (b = XMesaBufferList; b; b = b->Next) {
440      if (b == buffer) {
441         struct gl_framebuffer *fb = &buffer->stfb->Base;
442
443         /* unlink buffer from list */
444         if (prev)
445            prev->Next = buffer->Next;
446         else
447            XMesaBufferList = buffer->Next;
448
449         /* mark as delete pending */
450         fb->DeletePending = GL_TRUE;
451
452         /* Since the X window for the XMesaBuffer is going away, we don't
453          * want to dereference this pointer in the future.
454          */
455         b->drawable = 0;
456
457         buffer->tempImage->data = NULL;
458         XDestroyImage(buffer->tempImage);
459
460         /* Unreference.  If count = zero we'll really delete the buffer */
461         _mesa_reference_framebuffer(&fb, NULL);
462
463         XFreeGC(b->xm_visual->display, b->gc);
464
465         free(buffer);
466
467         return;
468      }
469      /* continue search */
470      prev = b;
471   }
472   /* buffer not found in XMesaBufferList */
473   _mesa_problem(NULL,"xmesa_free_buffer() - buffer not found\n");
474}
475
476
477
478/**********************************************************************/
479/*****                   Misc Private Functions                   *****/
480/**********************************************************************/
481
482
483/**
484 * When a context is bound for the first time, we can finally finish
485 * initializing the context's visual and buffer information.
486 * \param v  the XMesaVisual to initialize
487 * \param b  the XMesaBuffer to initialize (may be NULL)
488 * \param rgb_flag  TRUE = RGBA mode, FALSE = color index mode
489 * \param window  the window/pixmap we're rendering into
490 * \param cmap  the colormap associated with the window/pixmap
491 * \return GL_TRUE=success, GL_FALSE=failure
492 */
493static GLboolean
494initialize_visual_and_buffer(XMesaVisual v, XMesaBuffer b,
495                             GLboolean rgb_flag, Drawable window,
496                             Colormap cmap)
497{
498   ASSERT(!b || b->xm_visual == v);
499
500   /* Save true bits/pixel */
501   v->BitsPerPixel = bits_per_pixel(v);
502   assert(v->BitsPerPixel > 0);
503
504   if (rgb_flag == GL_FALSE) {
505      /* COLOR-INDEXED WINDOW: not supported*/
506      return GL_FALSE;
507   }
508   else {
509      /* RGB WINDOW:
510       * We support RGB rendering into almost any kind of visual.
511       */
512      const int xclass = v->mesa_visual.visualType;
513      if (xclass != GLX_TRUE_COLOR && xclass == !GLX_DIRECT_COLOR) {
514	 _mesa_warning(NULL,
515            "XMesa: RGB mode rendering not supported in given visual.\n");
516	 return GL_FALSE;
517      }
518      v->mesa_visual.indexBits = 0;
519
520      if (v->BitsPerPixel == 32) {
521         /* We use XImages for all front/back buffers.  If an X Window or
522          * X Pixmap is 32bpp, there's no guarantee that the alpha channel
523          * will be preserved.  For XImages we're in luck.
524          */
525         v->mesa_visual.alphaBits = 8;
526      }
527   }
528
529   /*
530    * If MESA_INFO env var is set print out some debugging info
531    * which can help Brian figure out what's going on when a user
532    * reports bugs.
533    */
534   if (_mesa_getenv("MESA_INFO")) {
535      _mesa_printf("X/Mesa visual = %p\n", (void *) v);
536      _mesa_printf("X/Mesa level = %d\n", v->mesa_visual.level);
537      _mesa_printf("X/Mesa depth = %d\n", v->visinfo->depth);
538      _mesa_printf("X/Mesa bits per pixel = %d\n", v->BitsPerPixel);
539   }
540
541   if (b && window) {
542      /* these should have been set in create_xmesa_buffer */
543      ASSERT(b->drawable == window);
544
545      /* Setup for single/double buffering */
546      if (v->mesa_visual.doubleBufferMode) {
547         /* Double buffered */
548         b->shm = xmesa_check_for_xshm( v->display );
549      }
550
551      /* X11 graphics context */
552      b->gc = XCreateGC( v->display, window, 0, NULL );
553      XSetFunction( v->display, b->gc, GXcopy );
554   }
555
556   return GL_TRUE;
557}
558
559
560
561#define NUM_VISUAL_TYPES   6
562
563/**
564 * Convert an X visual type to a GLX visual type.
565 *
566 * \param visualType X visual type (i.e., \c TrueColor, \c StaticGray, etc.)
567 *        to be converted.
568 * \return If \c visualType is a valid X visual type, a GLX visual type will
569 *         be returned.  Otherwise \c GLX_NONE will be returned.
570 *
571 * \note
572 * This code was lifted directly from lib/GL/glx/glcontextmodes.c in the
573 * DRI CVS tree.
574 */
575static GLint
576xmesa_convert_from_x_visual_type( int visualType )
577{
578    static const int glx_visual_types[ NUM_VISUAL_TYPES ] = {
579	GLX_STATIC_GRAY,  GLX_GRAY_SCALE,
580	GLX_STATIC_COLOR, GLX_PSEUDO_COLOR,
581	GLX_TRUE_COLOR,   GLX_DIRECT_COLOR
582    };
583
584    return ( (unsigned) visualType < NUM_VISUAL_TYPES )
585	? glx_visual_types[ visualType ] : GLX_NONE;
586}
587
588
589/**********************************************************************/
590/*****                       Public Functions                     *****/
591/**********************************************************************/
592
593
594/*
595 * Create a new X/Mesa visual.
596 * Input:  display - X11 display
597 *         visinfo - an XVisualInfo pointer
598 *         rgb_flag - GL_TRUE = RGB mode,
599 *                    GL_FALSE = color index mode
600 *         alpha_flag - alpha buffer requested?
601 *         db_flag - GL_TRUE = double-buffered,
602 *                   GL_FALSE = single buffered
603 *         stereo_flag - stereo visual?
604 *         ximage_flag - GL_TRUE = use an XImage for back buffer,
605 *                       GL_FALSE = use an off-screen pixmap for back buffer
606 *         depth_size - requested bits/depth values, or zero
607 *         stencil_size - requested bits/stencil values, or zero
608 *         accum_red_size - requested bits/red accum values, or zero
609 *         accum_green_size - requested bits/green accum values, or zero
610 *         accum_blue_size - requested bits/blue accum values, or zero
611 *         accum_alpha_size - requested bits/alpha accum values, or zero
612 *         num_samples - number of samples/pixel if multisampling, or zero
613 *         level - visual level, usually 0
614 *         visualCaveat - ala the GLX extension, usually GLX_NONE
615 * Return;  a new XMesaVisual or 0 if error.
616 */
617PUBLIC
618XMesaVisual XMesaCreateVisual( Display *display,
619                               XVisualInfo * visinfo,
620                               GLboolean rgb_flag,
621                               GLboolean alpha_flag,
622                               GLboolean db_flag,
623                               GLboolean stereo_flag,
624                               GLboolean ximage_flag,
625                               GLint depth_size,
626                               GLint stencil_size,
627                               GLint accum_red_size,
628                               GLint accum_green_size,
629                               GLint accum_blue_size,
630                               GLint accum_alpha_size,
631                               GLint num_samples,
632                               GLint level,
633                               GLint visualCaveat )
634{
635   XMesaVisual v;
636   GLint red_bits, green_bits, blue_bits, alpha_bits;
637
638   /* For debugging only */
639   if (_mesa_getenv("MESA_XSYNC")) {
640      /* This makes debugging X easier.
641       * In your debugger, set a breakpoint on _XError to stop when an
642       * X protocol error is generated.
643       */
644      XSynchronize( display, 1 );
645   }
646
647   v = (XMesaVisual) CALLOC_STRUCT(xmesa_visual);
648   if (!v) {
649      return NULL;
650   }
651
652   v->display = display;
653
654   /* Save a copy of the XVisualInfo struct because the user may X_mesa_free()
655    * the struct but we may need some of the information contained in it
656    * at a later time.
657    */
658   v->visinfo = (XVisualInfo *) MALLOC(sizeof(*visinfo));
659   if(!v->visinfo) {
660      _mesa_free(v);
661      return NULL;
662   }
663   MEMCPY(v->visinfo, visinfo, sizeof(*visinfo));
664
665   v->ximage_flag = ximage_flag;
666
667   v->mesa_visual.redMask = visinfo->red_mask;
668   v->mesa_visual.greenMask = visinfo->green_mask;
669   v->mesa_visual.blueMask = visinfo->blue_mask;
670   v->mesa_visual.visualID = visinfo->visualid;
671   v->mesa_visual.screen = visinfo->screen;
672
673#if !(defined(__cplusplus) || defined(c_plusplus))
674   v->mesa_visual.visualType = xmesa_convert_from_x_visual_type(visinfo->class);
675#else
676   v->mesa_visual.visualType = xmesa_convert_from_x_visual_type(visinfo->c_class);
677#endif
678
679   v->mesa_visual.visualRating = visualCaveat;
680
681   if (alpha_flag)
682      v->mesa_visual.alphaBits = 8;
683
684   (void) initialize_visual_and_buffer( v, NULL, rgb_flag, 0, 0 );
685
686   {
687      const int xclass = v->mesa_visual.visualType;
688      if (xclass == GLX_TRUE_COLOR || xclass == GLX_DIRECT_COLOR) {
689         red_bits   = _mesa_bitcount(GET_REDMASK(v));
690         green_bits = _mesa_bitcount(GET_GREENMASK(v));
691         blue_bits  = _mesa_bitcount(GET_BLUEMASK(v));
692      }
693      else {
694         /* this is an approximation */
695         int depth;
696         depth = v->visinfo->depth;
697         red_bits = depth / 3;
698         depth -= red_bits;
699         green_bits = depth / 2;
700         depth -= green_bits;
701         blue_bits = depth;
702         alpha_bits = 0;
703         assert( red_bits + green_bits + blue_bits == v->visinfo->depth );
704      }
705      alpha_bits = v->mesa_visual.alphaBits;
706   }
707
708   _mesa_initialize_visual( &v->mesa_visual,
709                            rgb_flag, db_flag, stereo_flag,
710                            red_bits, green_bits,
711                            blue_bits, alpha_bits,
712                            v->mesa_visual.indexBits,
713                            depth_size,
714                            stencil_size,
715                            accum_red_size, accum_green_size,
716                            accum_blue_size, accum_alpha_size,
717                            0 );
718
719   /* XXX minor hack */
720   v->mesa_visual.level = level;
721   return v;
722}
723
724
725PUBLIC
726void XMesaDestroyVisual( XMesaVisual v )
727{
728   _mesa_free(v->visinfo);
729   _mesa_free(v);
730}
731
732
733
734/**
735 * Create a new XMesaContext.
736 * \param v  the XMesaVisual
737 * \param share_list  another XMesaContext with which to share display
738 *                    lists or NULL if no sharing is wanted.
739 * \return an XMesaContext or NULL if error.
740 */
741PUBLIC
742XMesaContext XMesaCreateContext( XMesaVisual v, XMesaContext share_list )
743{
744   static GLboolean firstTime = GL_TRUE;
745   struct pipe_screen *screen;
746   struct pipe_context *pipe;
747   XMesaContext c;
748   GLcontext *mesaCtx;
749   uint pf;
750
751   if (firstTime) {
752      pipe_mutex_init(_xmesa_lock);
753      firstTime = GL_FALSE;
754   }
755
756   /* Note: the XMesaContext contains a Mesa GLcontext struct (inheritance) */
757   c = (XMesaContext) CALLOC_STRUCT(xmesa_context);
758   if (!c)
759      return NULL;
760
761   pf = choose_pixel_format(v);
762   assert(pf);
763
764   c->xm_visual = v;
765   c->xm_buffer = NULL;   /* set later by XMesaMakeCurrent */
766   c->xm_read_buffer = NULL;
767
768   /* XXX: create once per Xlib Display.
769    */
770   screen = driver.create_pipe_screen();
771   if (screen == NULL)
772      goto fail;
773
774   pipe = driver.create_pipe_context( screen,
775                                     (void *)c );
776   if (pipe == NULL)
777      goto fail;
778
779   c->st = st_create_context(pipe,
780                             &v->mesa_visual,
781                             share_list ? share_list->st : NULL);
782   if (c->st == NULL)
783      goto fail;
784
785   mesaCtx = c->st->ctx;
786   c->st->ctx->DriverCtx = c;
787
788#if 00
789   _mesa_enable_sw_extensions(mesaCtx);
790   _mesa_enable_1_3_extensions(mesaCtx);
791   _mesa_enable_1_4_extensions(mesaCtx);
792   _mesa_enable_1_5_extensions(mesaCtx);
793   _mesa_enable_2_0_extensions(mesaCtx);
794#endif
795
796   return c;
797
798 fail:
799   if (c->st)
800      st_destroy_context(c->st);
801   else if (pipe)
802      pipe->destroy(pipe);
803
804   if (screen)
805      screen->destroy( screen );
806
807   FREE(c);
808   return NULL;
809}
810
811
812
813PUBLIC
814void XMesaDestroyContext( XMesaContext c )
815{
816   st_destroy_context(c->st);
817
818   /* FIXME: We should destroy the screen here, but if we do so, surfaces may
819    * outlive it, causing segfaults
820   struct pipe_screen *screen = c->st->pipe->screen;
821   screen->destroy(screen);
822   */
823
824   _mesa_free(c);
825}
826
827
828
829/**
830 * Private function for creating an XMesaBuffer which corresponds to an
831 * X window or pixmap.
832 * \param v  the window's XMesaVisual
833 * \param w  the window we're wrapping
834 * \return  new XMesaBuffer or NULL if error
835 */
836PUBLIC XMesaBuffer
837XMesaCreateWindowBuffer(XMesaVisual v, Window w)
838{
839   XWindowAttributes attr;
840   XMesaBuffer b;
841   Colormap cmap;
842   int depth;
843
844   assert(v);
845   assert(w);
846
847   /* Check that window depth matches visual depth */
848   XGetWindowAttributes( v->display, w, &attr );
849   depth = attr.depth;
850   if (v->visinfo->depth != depth) {
851      _mesa_warning(NULL, "XMesaCreateWindowBuffer: depth mismatch between visual (%d) and window (%d)!\n",
852                    v->visinfo->depth, depth);
853      return NULL;
854   }
855
856   /* Find colormap */
857   if (attr.colormap) {
858      cmap = attr.colormap;
859   }
860   else {
861      _mesa_warning(NULL, "Window %u has no colormap!\n", (unsigned int) w);
862      /* this is weird, a window w/out a colormap!? */
863      /* OK, let's just allocate a new one and hope for the best */
864      cmap = XCreateColormap(v->display, w, attr.visual, AllocNone);
865   }
866
867   b = create_xmesa_buffer((Drawable) w, WINDOW, v, cmap);
868   if (!b)
869      return NULL;
870
871   if (!initialize_visual_and_buffer( v, b, v->mesa_visual.rgbMode,
872                                      (Drawable) w, cmap )) {
873      xmesa_free_buffer(b);
874      return NULL;
875   }
876
877   return b;
878}
879
880
881
882/**
883 * Create a new XMesaBuffer from an X pixmap.
884 *
885 * \param v    the XMesaVisual
886 * \param p    the pixmap
887 * \param cmap the colormap, may be 0 if using a \c GLX_TRUE_COLOR or
888 *             \c GLX_DIRECT_COLOR visual for the pixmap
889 * \returns new XMesaBuffer or NULL if error
890 */
891PUBLIC XMesaBuffer
892XMesaCreatePixmapBuffer(XMesaVisual v, Pixmap p, Colormap cmap)
893{
894   XMesaBuffer b;
895
896   assert(v);
897
898   b = create_xmesa_buffer((Drawable) p, PIXMAP, v, cmap);
899   if (!b)
900      return NULL;
901
902   if (!initialize_visual_and_buffer(v, b, v->mesa_visual.rgbMode,
903				     (Drawable) p, cmap)) {
904      xmesa_free_buffer(b);
905      return NULL;
906   }
907
908   return b;
909}
910
911
912/**
913 * For GLX_EXT_texture_from_pixmap
914 */
915XMesaBuffer
916XMesaCreatePixmapTextureBuffer(XMesaVisual v, Pixmap p,
917                               Colormap cmap,
918                               int format, int target, int mipmap)
919{
920   GET_CURRENT_CONTEXT(ctx);
921   XMesaBuffer b;
922   GLuint width, height;
923
924   assert(v);
925
926   b = create_xmesa_buffer((Drawable) p, PIXMAP, v, cmap);
927   if (!b)
928      return NULL;
929
930   /* get pixmap size, update framebuffer/renderbuffer dims */
931   xmesa_get_window_size(v->display, b, &width, &height);
932   _mesa_resize_framebuffer(NULL, &(b->stfb->Base), width, height);
933
934   if (target == 0) {
935      /* examine dims */
936      if (ctx->Extensions.ARB_texture_non_power_of_two) {
937         target = GLX_TEXTURE_2D_EXT;
938      }
939      else if (   _mesa_bitcount(width)  == 1
940               && _mesa_bitcount(height) == 1) {
941         /* power of two size */
942         if (height == 1) {
943            target = GLX_TEXTURE_1D_EXT;
944         }
945         else {
946            target = GLX_TEXTURE_2D_EXT;
947         }
948      }
949      else if (ctx->Extensions.NV_texture_rectangle) {
950         target = GLX_TEXTURE_RECTANGLE_EXT;
951      }
952      else {
953         /* non power of two textures not supported */
954         XMesaDestroyBuffer(b);
955         return 0;
956      }
957   }
958
959   b->TextureTarget = target;
960   b->TextureFormat = format;
961   b->TextureMipmap = mipmap;
962
963   if (!initialize_visual_and_buffer(v, b, v->mesa_visual.rgbMode,
964				     (Drawable) p, cmap)) {
965      xmesa_free_buffer(b);
966      return NULL;
967   }
968
969   return b;
970}
971
972
973
974XMesaBuffer
975XMesaCreatePBuffer(XMesaVisual v, Colormap cmap,
976                   unsigned int width, unsigned int height)
977{
978   Window root;
979   Drawable drawable;  /* X Pixmap Drawable */
980   XMesaBuffer b;
981
982   /* allocate pixmap for front buffer */
983   root = RootWindow( v->display, v->visinfo->screen );
984   drawable = XCreatePixmap(v->display, root, width, height,
985                            v->visinfo->depth);
986   if (!drawable)
987      return NULL;
988
989   b = create_xmesa_buffer(drawable, PBUFFER, v, cmap);
990   if (!b)
991      return NULL;
992
993   if (!initialize_visual_and_buffer(v, b, v->mesa_visual.rgbMode,
994				     drawable, cmap)) {
995      xmesa_free_buffer(b);
996      return NULL;
997   }
998
999   return b;
1000}
1001
1002
1003
1004/*
1005 * Deallocate an XMesaBuffer structure and all related info.
1006 */
1007PUBLIC void
1008XMesaDestroyBuffer(XMesaBuffer b)
1009{
1010   xmesa_free_buffer(b);
1011}
1012
1013
1014/**
1015 * Query the current window size and update the corresponding GLframebuffer
1016 * and all attached renderbuffers.
1017 * Called when:
1018 *  1. the first time a buffer is bound to a context.
1019 *  2. SwapBuffers.  XXX probabaly from xm_flush_frontbuffer() too...
1020 * Note: it's possible (and legal) for xmctx to be NULL.  That can happen
1021 * when resizing a buffer when no rendering context is bound.
1022 */
1023void
1024xmesa_check_and_update_buffer_size(XMesaContext xmctx, XMesaBuffer drawBuffer)
1025{
1026   GLuint width, height;
1027   xmesa_get_window_size(drawBuffer->xm_visual->display, drawBuffer, &width, &height);
1028   st_resize_framebuffer(drawBuffer->stfb, width, height);
1029}
1030
1031
1032
1033
1034/*
1035 * Bind buffer b to context c and make c the current rendering context.
1036 */
1037PUBLIC
1038GLboolean XMesaMakeCurrent2( XMesaContext c, XMesaBuffer drawBuffer,
1039                             XMesaBuffer readBuffer )
1040{
1041   XMesaContext old_ctx = XMesaGetCurrentContext();
1042
1043   if (old_ctx && old_ctx != c) {
1044      XMesaFlush(old_ctx);
1045      old_ctx->xm_buffer = NULL;
1046      old_ctx->xm_read_buffer = NULL;
1047   }
1048
1049   if (c) {
1050      if (!drawBuffer || !readBuffer)
1051         return GL_FALSE;  /* must specify buffers! */
1052
1053      if (c == old_ctx &&
1054	  c->xm_buffer == drawBuffer &&
1055	  c->xm_read_buffer == readBuffer)
1056	 return GL_TRUE;
1057
1058      c->xm_buffer = drawBuffer;
1059      c->xm_read_buffer = readBuffer;
1060
1061      /* Call this periodically to detect when the user has begun using
1062       * GL rendering from multiple threads.
1063       */
1064      _glapi_check_multithread();
1065
1066      st_make_current(c->st, drawBuffer->stfb, readBuffer->stfb);
1067
1068      xmesa_check_and_update_buffer_size(c, drawBuffer);
1069      if (readBuffer != drawBuffer)
1070         xmesa_check_and_update_buffer_size(c, readBuffer);
1071
1072      /* Solution to Stephane Rehel's problem with glXReleaseBuffersMESA(): */
1073      drawBuffer->wasCurrent = GL_TRUE;
1074   }
1075   else {
1076      /* Detach */
1077      st_make_current( NULL, NULL, NULL );
1078
1079   }
1080   return GL_TRUE;
1081}
1082
1083
1084/*
1085 * Unbind the context c from its buffer.
1086 */
1087GLboolean XMesaUnbindContext( XMesaContext c )
1088{
1089   /* A no-op for XFree86 integration purposes */
1090   return GL_TRUE;
1091}
1092
1093
1094XMesaContext XMesaGetCurrentContext( void )
1095{
1096   GET_CURRENT_CONTEXT(ctx);
1097   if (ctx) {
1098      XMesaContext xmesa = xmesa_context(ctx);
1099      return xmesa;
1100   }
1101   else {
1102      return 0;
1103   }
1104}
1105
1106
1107
1108
1109
1110
1111/*
1112 * Copy the back buffer to the front buffer.  If there's no back buffer
1113 * this is a no-op.
1114 */
1115PUBLIC
1116void XMesaSwapBuffers( XMesaBuffer b )
1117{
1118   struct pipe_surface *surf;
1119
1120   /* If we're swapping the buffer associated with the current context
1121    * we have to flush any pending rendering commands first.
1122    */
1123   st_notify_swapbuffers(b->stfb);
1124
1125   st_get_framebuffer_surface(b->stfb, ST_SURFACE_BACK_LEFT, &surf);
1126   if (surf) {
1127      driver.display_surface(b, surf);
1128   }
1129
1130   xmesa_check_and_update_buffer_size(NULL, b);
1131}
1132
1133
1134
1135/*
1136 * Copy sub-region of back buffer to front buffer
1137 */
1138void XMesaCopySubBuffer( XMesaBuffer b, int x, int y, int width, int height )
1139{
1140   struct pipe_surface *surf_front;
1141   struct pipe_surface *surf_back;
1142   struct pipe_context *pipe = NULL; /* XXX fix */
1143
1144   st_get_framebuffer_surface(b->stfb, ST_SURFACE_FRONT_LEFT, &surf_front);
1145   st_get_framebuffer_surface(b->stfb, ST_SURFACE_BACK_LEFT, &surf_back);
1146
1147   if (!surf_front || !surf_back)
1148      return;
1149
1150   pipe->surface_copy(pipe,
1151                      surf_front, x, y,  /* dest */
1152                      surf_back, x, y,   /* src */
1153                      width, height);
1154}
1155
1156
1157
1158void XMesaFlush( XMesaContext c )
1159{
1160   if (c && c->xm_visual->display) {
1161      st_finish(c->st);
1162      XSync( c->xm_visual->display, False );
1163   }
1164}
1165
1166
1167
1168
1169
1170XMesaBuffer XMesaFindBuffer( Display *dpy, Drawable d )
1171{
1172   XMesaBuffer b;
1173   for (b=XMesaBufferList; b; b=b->Next) {
1174      if (b->drawable == d && b->xm_visual->display == dpy) {
1175         return b;
1176      }
1177   }
1178   return NULL;
1179}
1180
1181
1182/**
1183 * Free/destroy all XMesaBuffers associated with given display.
1184 */
1185void xmesa_destroy_buffers_on_display(Display *dpy)
1186{
1187   XMesaBuffer b, next;
1188   for (b = XMesaBufferList; b; b = next) {
1189      next = b->Next;
1190      if (b->xm_visual->display == dpy) {
1191         xmesa_free_buffer(b);
1192      }
1193   }
1194}
1195
1196
1197/*
1198 * Look for XMesaBuffers whose X window has been destroyed.
1199 * Deallocate any such XMesaBuffers.
1200 */
1201void XMesaGarbageCollect( void )
1202{
1203   XMesaBuffer b, next;
1204   for (b=XMesaBufferList; b; b=next) {
1205      next = b->Next;
1206      if (b->xm_visual &&
1207          b->xm_visual->display &&
1208          b->drawable &&
1209          b->type == WINDOW) {
1210         XSync(b->xm_visual->display, False);
1211         if (!window_exists( b->xm_visual->display, b->drawable )) {
1212            /* found a dead window, free the ancillary info */
1213            XMesaDestroyBuffer( b );
1214         }
1215      }
1216   }
1217}
1218
1219
1220
1221
1222PUBLIC void
1223XMesaBindTexImage(Display *dpy, XMesaBuffer drawable, int buffer,
1224                  const int *attrib_list)
1225{
1226}
1227
1228
1229
1230PUBLIC void
1231XMesaReleaseTexImage(Display *dpy, XMesaBuffer drawable, int buffer)
1232{
1233}
1234
1235