a bunch of thread-safety changes
[mesa.git] / src / mesa / drivers / x11 / xmesaP.h
1 /* $Id: xmesaP.h,v 1.11 2000/07/19 23:26:35 brianp Exp $ */
2
3 /*
4 * Mesa 3-D graphics library
5 * Version: 3.3
6 *
7 * Copyright (C) 1999-2000 Brian Paul All Rights Reserved.
8 *
9 * Permission is hereby granted, free of charge, to any person obtaining a
10 * copy of this software and associated documentation files (the "Software"),
11 * to deal in the Software without restriction, including without limitation
12 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
13 * and/or sell copies of the Software, and to permit persons to whom the
14 * Software is furnished to do so, subject to the following conditions:
15 *
16 * The above copyright notice and this permission notice shall be included
17 * in all copies or substantial portions of the Software.
18 *
19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
20 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
22 * BRIAN PAUL BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
23 * AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
24 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
25 */
26
27
28 #ifndef XMESAP_H
29 #define XMESAP_H
30
31
32 #ifdef XFree86Server
33 # include "GL/xf86glx.h"
34 # include "xf86glx_util.h"
35 #else
36 # ifdef GLX_DIRECT_RENDERING
37 # include "dri_mesa.h"
38 # endif
39 # ifdef USE_XSHM
40 # include <X11/extensions/XShm.h>
41 # endif
42 #endif
43 #include "GL/xmesa.h"
44 #include "types.h"
45 #if defined(FX) && !defined(GLX_DIRECT_RENDERING)
46 #include "GL/fxmesa.h"
47 #include "../FX/fxdrv.h"
48 #endif
49
50
51 #if defined(GLX_DIRECT_RENDERING) && !defined(XFree86Server)
52 # include "xdriP.h"
53 #else
54 # define DRI_DRAWABLE_ARG
55 # define DRI_DRAWABLE_PARM
56 # define DRI_CTX_ARG
57 #endif
58
59
60 extern _glthread_Mutex _xmesa_lock;
61
62
63 /* for PF_8R8G8B24 pixel format */
64 typedef struct {
65 GLubyte b;
66 GLubyte g;
67 GLubyte r;
68 } bgr_t;
69
70
71 /* Function pointer for clearing color buffers */
72 typedef void (*clear_func)( GLcontext *ctx,
73 GLboolean all, GLint x, GLint y,
74 GLint width, GLint height );
75
76
77 /*
78 * "Derived" from gl_visual. Basically corresponds to an XVisualInfo.
79 */
80 struct xmesa_visual {
81 GLvisual *gl_visual; /* Device independent visual parameters */
82 XMesaDisplay *display; /* The X11 display */
83 #ifdef XFree86Server
84 GLint screen_depth; /* The depth of the screen */
85 #else
86 XVisualInfo *vishandle; /* The pointer returned by glXChooseVisual */
87 #endif
88 XMesaVisualInfo visinfo; /* X's visual info */
89 GLint BitsPerPixel; /* True bits per pixel for XImages */
90
91 GLint level; /* 0=normal, 1=overlay, etc */
92 GLint VisualCaveat; /* for GLX_EXT_visual_rating extension */
93
94 GLboolean ximage_flag; /* Use XImage for back buffer (not pixmap)? */
95
96 GLuint dithered_pf; /* Pixel format when dithering */
97 GLuint undithered_pf; /* Pixel format when not dithering */
98
99 GLfloat RedGamma; /* Gamma values, 1.0 is default */
100 GLfloat GreenGamma;
101 GLfloat BlueGamma;
102
103 GLint rmult, gmult, bmult; /* Range of color values */
104 GLint index_bits; /* Bits per pixel in CI mode */
105
106 /* For PF_TRUECOLOR */
107 GLint rshift, gshift, bshift;/* Pixel color component shifts */
108 GLubyte Kernel[16]; /* Dither kernel */
109 unsigned long RtoPixel[512]; /* RGB to pixel conversion */
110 unsigned long GtoPixel[512];
111 unsigned long BtoPixel[512];
112 GLubyte PixelToR[256]; /* Pixel to RGB conversion */
113 GLubyte PixelToG[256];
114 GLubyte PixelToB[256];
115
116 /* For PF_HPCR */
117 short hpcr_rgbTbl[3][256];
118 GLboolean hpcr_clear_flag;
119 GLubyte hpcr_clear_ximage_pattern[2][16];
120 XMesaImage *hpcr_clear_ximage;
121 XMesaPixmap hpcr_clear_pixmap;
122
123 /* For PF_1BIT */
124 int bitFlip;
125 };
126
127
128
129 /*
130 * "Derived" from gl_context. Basically corresponds to a GLXContext.
131 */
132 struct xmesa_context {
133 GLcontext *gl_ctx; /* the core library context */
134 XMesaVisual xm_visual; /* Describes the buffers */
135 XMesaBuffer xm_buffer; /* current draw framebuffer */
136 XMesaBuffer xm_read_buffer; /* current read framebuffer */
137 GLboolean use_read_buffer; /* read from the xm_read_buffer/ */
138
139 XMesaDisplay *display; /* == xm_visual->display */
140 GLboolean swapbytes; /* Host byte order != display byte order? */
141 GLboolean direct; /* Direct rendering context? */
142
143 GLuint pixelformat; /* Current pixel format */
144
145 GLubyte red, green, blue, alpha; /* current drawing color */
146 unsigned long pixel; /* current drawing pixel value */
147
148 GLubyte clearcolor[4]; /* current clearing color */
149 unsigned long clearpixel; /* current clearing pixel value */
150
151 #if defined(GLX_DIRECT_RENDERING) && !defined(XFree86Server)
152 __DRIcontextPrivate *driContextPriv; /* back pointer to DRI context
153 * used for locking
154 */
155 void *private; /* device-specific private context */
156 #endif
157 };
158
159
160
161 /*
162 * "Derived" from gl_buffer. Basically corresponds to a GLXDrawable.
163 */
164 struct xmesa_buffer {
165 GLboolean wasCurrent; /* was ever the current buffer? */
166 GLframebuffer *gl_buffer; /* depth, stencil, accum, etc buffers */
167 XMesaVisual xm_visual; /* the X/Mesa visual */
168
169 XMesaContext xm_context; /* the context associated with this buffer */
170 XMesaDisplay *display;
171 GLboolean pixmap_flag; /* is the buffer a Pixmap? */
172 XMesaDrawable frontbuffer; /* either a window or pixmap */
173 XMesaPixmap backpixmap; /* back buffer Pixmap */
174 XMesaImage *backimage; /* back buffer simulated XImage */
175
176 XMesaDrawable buffer; /* the current buffer, either equal to */
177 /* frontbuffer, backpixmap or XIMAGE (None) */
178
179 XMesaColormap cmap; /* the X colormap */
180
181 GLint db_state; /* 0 = single buffered */
182 /* BACK_PIXMAP = use Pixmap for back buffer */
183 /* BACK_XIMAGE = use XImage for back buffer */
184
185 #ifndef XFree86Server
186 GLuint shm; /* X Shared Memory extension status: */
187 /* 0 = not available */
188 /* 1 = XImage support available */
189 /* 2 = Pixmap support available too */
190 #ifdef USE_XSHM
191 XShmSegmentInfo shminfo;
192 #endif
193 #endif
194
195 XMesaImage *rowimage; /* Used for optimized span writing */
196
197 GLuint width, height; /* size of buffer */
198
199 GLint bottom; /* used for FLIP macro below */
200 GLubyte *ximage_origin1; /* used for PIXELADDR1 macro */
201 GLint ximage_width1;
202 GLushort *ximage_origin2; /* used for PIXELADDR2 macro */
203 GLint ximage_width2;
204 GLubyte *ximage_origin3; /* used for PIXELADDR3 macro */
205 GLint ximage_width3;
206 GLuint *ximage_origin4; /* used for PIXELADDR4 macro */
207 GLint ximage_width4;
208
209 XMesaPixmap stipple_pixmap; /* For polygon stippling */
210 XMesaGC stipple_gc; /* For polygon stippling */
211
212 XMesaGC gc1; /* GC for infrequent color changes */
213 XMesaGC gc2; /* GC for frequent color changes */
214 XMesaGC cleargc; /* GC for clearing the color buffer */
215
216 /* The following are here instead of in the XMesaVisual
217 * because they depend on the window's colormap.
218 */
219
220 /* For PF_DITHER, PF_LOOKUP, PF_GRAYSCALE */
221 unsigned long color_table[576]; /* RGB -> pixel value */
222
223 /* For PF_DITHER, PF_LOOKUP, PF_GRAYSCALE */
224 GLubyte pixel_to_r[65536]; /* pixel value -> red */
225 GLubyte pixel_to_g[65536]; /* pixel value -> green */
226 GLubyte pixel_to_b[65536]; /* pixel value -> blue */
227
228 /* Used to do XAllocColor/XFreeColors accounting: */
229 int num_alloced;
230 unsigned long alloced_colors[256];
231
232 #if defined(GLX_DIRECT_RENDERING) && !defined(XFree86Server)
233 __DRIdrawablePrivate *driDrawPriv; /* back pointer to DRI drawable
234 * used for direct access to framebuffer
235 */
236 void *private; /* device-specific private drawable */
237 #endif
238
239 #if defined( FX ) && !defined(GLX_DIRECT_RENDERING)
240 /* For 3Dfx Glide only */
241 GLboolean FXisHackUsable; /* Can we render into window? */
242 GLboolean FXwindowHack; /* Are we rendering into a window? */
243 fxMesaContext FXctx;
244 #endif
245
246 /* functions for clearing the front and back color buffers */
247 clear_func front_clear_func;
248 clear_func back_clear_func;
249
250 struct xmesa_buffer *Next; /* Linked list pointer: */
251 };
252
253
254
255 /* Values for xmesa->dest: */
256 #define FRONT_PIXMAP 1
257 #define BACK_PIXMAP 2
258 #define BACK_XIMAGE 4
259
260
261 /* Values for xmesa->pixelformat: */
262 #define PF_INDEX 1 /* Color Index mode */
263 #define PF_TRUECOLOR 2 /* TrueColor or DirectColor, any depth */
264 #define PF_TRUEDITHER 3 /* TrueColor with dithering */
265 #define PF_8A8B8G8R 4 /* 32-bit TrueColor: 8-A, 8-B, 8-G, 8-R */
266 #define PF_8R8G8B 5 /* 32-bit TrueColor: 8-R, 8-G, 8-B bits */
267 #define PF_5R6G5B 6 /* 16-bit TrueColor: 5-R, 6-G, 5-B bits */
268 #define PF_DITHER 7 /* Color-mapped RGB with dither */
269 #define PF_LOOKUP 8 /* Color-mapped RGB without dither */
270 #define PF_HPCR 9 /* HP Color Recovery (ad@lms.be 30/08/95) */
271 #define PF_1BIT 10 /* monochrome dithering of RGB */
272 #define PF_GRAYSCALE 11 /* Grayscale or StaticGray */
273 #define PF_8R8G8B24 12 /* 24-bit TrueColor: 8-R, 8-G, 8-B bits */
274 #define PF_DITHER_5R6G5B 13 /* 16-bit dithered TrueColor: 5-R, 6-G, 5-B */
275
276
277 /*
278 * If pixelformat==PF_TRUECOLOR:
279 */
280 #define PACK_TRUECOLOR( PIXEL, R, G, B ) \
281 PIXEL = xmesa->xm_visual->RtoPixel[R] \
282 | xmesa->xm_visual->GtoPixel[G] \
283 | xmesa->xm_visual->BtoPixel[B]; \
284
285
286 /*
287 * If pixelformat==PF_TRUEDITHER:
288 */
289 #define PACK_TRUEDITHER( PIXEL, X, Y, R, G, B ) \
290 { \
291 int d = xmesa->xm_visual->Kernel[((X)&3) | (((Y)&3)<<2)]; \
292 PIXEL = xmesa->xm_visual->RtoPixel[(R)+d] \
293 | xmesa->xm_visual->GtoPixel[(G)+d] \
294 | xmesa->xm_visual->BtoPixel[(B)+d]; \
295 }
296
297
298
299 /*
300 * If pixelformat==PF_8A8B8G8R:
301 */
302 #define PACK_8A8B8G8R( R, G, B, A ) \
303 ( ((A) << 24) | ((B) << 16) | ((G) << 8) | (R) )
304
305
306 /*
307 * Like PACK_8A8B8G8R() but don't use alpha. This is usually an acceptable
308 * shortcut.
309 */
310 #define PACK_8B8G8R( R, G, B ) ( ((B) << 16) | ((G) << 8) | (R) )
311
312
313
314 /*
315 * If pixelformat==PF_8R8G8B:
316 */
317 #define PACK_8R8G8B( R, G, B) ( ((R) << 16) | ((G) << 8) | (B) )
318
319
320 /*
321 * If pixelformat==PF_5R6G5B:
322 */
323 #define PACK_5R6G5B( R, G, B) ( (((R) & 0xf8) << 8) | (((G) & 0xfc) << 3) | ((B) >> 3) )
324
325
326
327
328 /*
329 * If pixelformat==PF_DITHER:
330 *
331 * Improved 8-bit RGB dithering code contributed by Bob Mercier
332 * (mercier@hollywood.cinenet.net). Thanks Bob!
333 */
334 #undef _R
335 #undef _G
336 #undef _B
337 #undef _D
338 #ifdef DITHER666
339 # define _R 6
340 # define _G 6
341 # define _B 6
342 # define _MIX(r,g,b) (((r)*_G+(g))*_B+(b))
343 #else
344 # define _R 5
345 # define _G 9
346 # define _B 5
347 # define _MIX(r,g,b) ( ((g)<<6) | ((b)<<3) | (r) )
348 #endif
349 #define _DX 4
350 #define _DY 4
351 #define _D (_DX*_DY)
352
353 /*#define _DITH(C,c,d) (((unsigned)((_D*(C-1)+1)*c+d))/(_D*256))*/
354 #define _DITH(C,c,d) (((unsigned)((_D*(C-1)+1)*c+d)) >> 12)
355
356 #define MAXC 256
357 static int kernel8[_DY*_DX] = {
358 0 * MAXC, 8 * MAXC, 2 * MAXC, 10 * MAXC,
359 12 * MAXC, 4 * MAXC, 14 * MAXC, 6 * MAXC,
360 3 * MAXC, 11 * MAXC, 1 * MAXC, 9 * MAXC,
361 15 * MAXC, 7 * MAXC, 13 * MAXC, 5 * MAXC,
362 };
363 /*static int __d;*/
364
365 /* Dither for random X,Y */
366 #define DITHER_SETUP \
367 int __d; \
368 unsigned long *ctable = xmesa->xm_buffer->color_table;
369
370 #define DITHER( X, Y, R, G, B ) \
371 (__d = kernel8[(((Y)&3)<<2) | ((X)&3)], \
372 ctable[_MIX(_DITH(_R, (R), __d), \
373 _DITH(_G, (G), __d), \
374 _DITH(_B, (B), __d))])
375
376 /* Dither for random X, fixed Y */
377 #define XDITHER_SETUP(Y) \
378 int __d; \
379 unsigned long *ctable = xmesa->xm_buffer->color_table; \
380 int *kernel = &kernel8[ ((Y)&3) << 2 ];
381
382 #define XDITHER( X, R, G, B ) \
383 (__d = kernel[(X)&3], \
384 ctable[_MIX(_DITH(_R, (R), __d), \
385 _DITH(_G, (G), __d), \
386 _DITH(_B, (B), __d))])
387
388
389
390 /*
391 * Dithering for flat-shaded triangles. Precompute all 16 possible
392 * pixel values given the triangle's RGB color. Contributed by Martin Shenk.
393 */
394 static GLushort DitherValues[16]; /* array of (up to) 16-bit pixel values */
395
396 #define FLAT_DITHER_SETUP( R, G, B ) \
397 { \
398 unsigned long *ctable = xmesa->xm_buffer->color_table; \
399 int msdr = (_D*((_R)-1)+1) * (R); \
400 int msdg = (_D*((_G)-1)+1) * (G); \
401 int msdb = (_D*((_B)-1)+1) * (B); \
402 int i; \
403 for (i=0;i<16;i++) { \
404 int k = kernel8[i]; \
405 int j = _MIX( (msdr+k)>>12, (msdg+k)>>12, (msdb+k)>>12 ); \
406 DitherValues[i] = (GLushort) ctable[j]; \
407 } \
408 }
409
410 #define FLAT_DITHER_ROW_SETUP(Y) \
411 GLushort *ditherRow = DitherValues + ( ((Y)&3) << 2);
412
413 #define FLAT_DITHER(X) ditherRow[(X)&3]
414
415
416
417 /*
418 * If pixelformat==PF_LOOKUP:
419 */
420 #define _DITH0(C,c) (((unsigned)((_D*(C-1)+1)*c)) >> 12)
421
422 #define LOOKUP_SETUP \
423 unsigned long *ctable = xmesa->xm_buffer->color_table
424
425 #define LOOKUP( R, G, B ) \
426 ctable[_MIX(_DITH0(_R, (R)), \
427 _DITH0(_G, (G)), \
428 _DITH0(_B, (B)))]
429
430
431
432 /*
433 * If pixelformat==PF_HPCR:
434 *
435 * HP Color Recovery dithering (ad@lms.be 30/08/95)
436 * HP has on it's 8-bit 700-series computers, a feature called
437 * 'Color Recovery'. This allows near 24-bit output (so they say).
438 * It is enabled by selecting the 8-bit TrueColor visual AND
439 * corresponding colormap (see tkInitWindow) AND doing some special
440 * dither.
441 */
442 static const short HPCR_DRGB[3][2][16] = {
443 {
444 { 16, -4, 1,-11, 14, -6, 3, -9, 15, -5, 2,-10, 13, -7, 4, -8},
445 {-15, 5, 0, 12,-13, 7, -2, 10,-14, 6, -1, 11,-12, 8, -3, 9}
446 },
447 {
448 {-11, 15, -7, 3, -8, 14, -4, 2,-10, 16, -6, 4, -9, 13, -5, 1},
449 { 12,-14, 8, -2, 9,-13, 5, -1, 11,-15, 7, -3, 10,-12, 6, 0}
450 },
451 {
452 { 6,-18, 26,-14, 2,-22, 30,-10, 8,-16, 28,-12, 4,-20, 32, -8},
453 { -4, 20,-24, 16, 0, 24,-28, 12, -6, 18,-26, 14, -2, 22,-30, 10}
454 }
455 };
456
457 #define DITHER_HPCR( X, Y, R, G, B ) \
458 ( ((xmesa->xm_visual->hpcr_rgbTbl[0][R] + HPCR_DRGB[0][(Y)&1][(X)&15]) & 0xE0) \
459 |(((xmesa->xm_visual->hpcr_rgbTbl[1][G] + HPCR_DRGB[1][(Y)&1][(X)&15]) & 0xE0)>>3) \
460 | ((xmesa->xm_visual->hpcr_rgbTbl[2][B] + HPCR_DRGB[2][(Y)&1][(X)&15])>>6) \
461 )
462
463
464
465 /*
466 * If pixelformat==PF_1BIT:
467 */
468 static int const kernel1[16] = {
469 0*47, 9*47, 4*47, 12*47, /* 47 = (255*3)/16 */
470 6*47, 2*47, 14*47, 8*47,
471 10*47, 1*47, 5*47, 11*47,
472 7*47, 13*47, 3*47, 15*47 };
473
474 #define SETUP_1BIT int bitFlip = xmesa->xm_visual->bitFlip
475 #define DITHER_1BIT( X, Y, R, G, B ) \
476 (( ((int)(R)+(int)(G)+(int)(B)) > kernel1[(((Y)&3) << 2) | ((X)&3)] ) ^ bitFlip)
477
478
479
480 /*
481 * If pixelformat==PF_GRAYSCALE:
482 */
483 #define GRAY_RGB( R, G, B ) xmesa->xm_buffer->color_table[((R) + (G) + (B))/3]
484
485
486
487 #define XIMAGE None
488
489
490 /*
491 * Converts a GL window Y coord to an X window Y coord:
492 */
493 #define FLIP(BUFFER, Y) ((BUFFER)->bottom-(Y))
494
495
496 /*
497 * Return the address of a 1, 2 or 4-byte pixel in the back XImage:
498 * X==0 is left, Y==0 is bottom.
499 */
500 #define PIXELADDR1( BUFFER, X, Y ) \
501 ( (BUFFER)->ximage_origin1 - (Y) * (BUFFER)->ximage_width1 + (X) )
502
503 #define PIXELADDR2( BUFFER, X, Y ) \
504 ( (BUFFER)->ximage_origin2 - (Y) * (BUFFER)->ximage_width2 + (X) )
505
506 #define PIXELADDR3( BUFFER, X, Y ) \
507 ( (bgr_t *) ( (BUFFER)->ximage_origin3 - (Y) * (BUFFER)->ximage_width3 + 3 * (X) ))
508
509 #define PIXELADDR4( BUFFER, X, Y ) \
510 ( (BUFFER)->ximage_origin4 - (Y) * (BUFFER)->ximage_width4 + (X) )
511
512
513
514 /*
515 * External functions:
516 */
517
518 extern unsigned long
519 xmesa_color_to_pixel( XMesaContext xmesa, GLubyte r, GLubyte g, GLubyte b, GLubyte a,
520 GLuint pixelFormat );
521
522 extern void xmesa_alloc_back_buffer( XMesaBuffer b );
523
524 extern void xmesa_update_state( GLcontext *ctx );
525
526 extern points_func xmesa_get_points_func( GLcontext *ctx );
527
528 extern line_func xmesa_get_line_func( GLcontext *ctx );
529
530 extern triangle_func xmesa_get_triangle_func( GLcontext *ctx );
531
532
533 /* XXX this is a hack to implement shared display lists with 3Dfx */
534 extern XMesaBuffer XMesaCreateWindowBuffer2( XMesaVisual v,
535 XMesaWindow w,
536 XMesaContext c
537 DRI_DRAWABLE_ARG
538 );
539
540 /*
541 * These are the extra routines required for integration with XFree86.
542 * None of these routines should be user visible. -KEM
543 */
544 extern void XMesaSetVisualDisplay( XMesaDisplay *dpy, XMesaVisual v );
545 extern GLboolean XMesaForceCurrent(XMesaContext c);
546 extern GLboolean XMesaLoseCurrent(XMesaContext c);
547 extern void XMesaReset( void );
548
549 #endif