]> git.cworth.org Git - apitrace/blob - retrace/glstate_images.cpp
glretrace: Fix dumping of cube map FBO attachements.
[apitrace] / retrace / glstate_images.cpp
1 /**************************************************************************
2  *
3  * Copyright 2011 Jose Fonseca
4  * All Rights Reserved.
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to deal
8  * in the Software without restriction, including without limitation the rights
9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10  * copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in
14  * all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22  * THE SOFTWARE.
23  *
24  **************************************************************************/
25
26
27 #include <assert.h>
28 #include <string.h>
29
30 #include <algorithm>
31 #include <iostream>
32
33 #include "image.hpp"
34 #include "json.hpp"
35 #include "glproc.hpp"
36 #include "glsize.hpp"
37 #include "glstate.hpp"
38 #include "glstate_internal.hpp"
39
40
41 #ifdef __linux__
42 #include <dlfcn.h>
43 #endif
44
45 #ifdef __APPLE__
46
47 #include <Carbon/Carbon.h>
48
49 #ifdef __cplusplus
50 extern "C" {
51 #endif
52
53 OSStatus CGSGetSurfaceBounds(CGSConnectionID, CGWindowID, CGSSurfaceID, CGRect *);
54
55 #ifdef __cplusplus
56 }
57 #endif
58
59 #endif /* __APPLE__ */
60
61
62 /* Change thi to one to force interpreting depth buffers as RGBA, which enables
63  * visualizing full dynamic range, until we can transmit HDR images to the GUI */
64 #define DEPTH_AS_RGBA 0
65
66
67 namespace glstate {
68
69
70 struct ImageDesc
71 {
72     GLint width;
73     GLint height;
74     GLint depth;
75     GLint internalFormat;
76
77     inline
78     ImageDesc() :
79         width(0),
80         height(0),
81         depth(0),
82         internalFormat(GL_NONE)
83     {}
84
85     inline bool
86     valid(void) const {
87         return width > 0 && height > 0 && depth > 0;
88     }
89 };
90
91
92 /**
93  * Sames as enumToString, but with special provision to handle formatsLUMINANCE_ALPHA.
94  *
95  * OpenGL 2.1 specification states that "internalFormat may (for backwards
96  * compatibility with the 1.0 version of the GL) also take on the integer
97  * values 1, 2, 3, and 4, which are equivalent to symbolic constants LUMINANCE,
98  * LUMINANCE ALPHA, RGB, and RGBA respectively". 
99  */
100 const char *
101 formatToString(GLenum internalFormat) {
102     switch (internalFormat) {
103     case 1:
104         return "GL_LUMINANCE";
105     case 2:
106         return "GL_LUMINANCE_ALPHA";
107     case 3:
108         return "GL_RGB";
109     case 4:
110         return "GL_RGBA";
111     default:
112         return enumToString(internalFormat);
113     }
114 }
115
116
117 /**
118  * OpenGL ES does not support glGetTexLevelParameteriv, but it is possible to
119  * probe whether a texture has a given size by crafting a dummy glTexSubImage()
120  * call.
121  */
122 static bool
123 probeTextureLevelSizeOES(GLenum target, GLint level, const GLint size[3]) {
124     while (glGetError() != GL_NO_ERROR)
125         ;
126
127     GLenum internalFormat = GL_RGBA;
128     GLenum type = GL_UNSIGNED_BYTE;
129     GLint dummy = 0;
130
131     switch (target) {
132     case GL_TEXTURE_2D:
133     case GL_TEXTURE_CUBE_MAP:
134     case GL_TEXTURE_CUBE_MAP_POSITIVE_X:
135     case GL_TEXTURE_CUBE_MAP_NEGATIVE_X:
136     case GL_TEXTURE_CUBE_MAP_POSITIVE_Y:
137     case GL_TEXTURE_CUBE_MAP_NEGATIVE_Y:
138     case GL_TEXTURE_CUBE_MAP_POSITIVE_Z:
139     case GL_TEXTURE_CUBE_MAP_NEGATIVE_Z:
140         glTexSubImage2D(target, level, size[0], size[1], 0, 0, internalFormat, type, &dummy);
141         break;
142     case GL_TEXTURE_3D_OES:
143         glTexSubImage3DOES(target, level, size[0], size[1], size[2], 0, 0, 0, internalFormat, type, &dummy);
144     default:
145         assert(0);
146         return false;
147     }
148
149     GLenum error = glGetError();
150
151     if (0) {
152         std::cerr << "(" << size[0] << ", " << size[1] << ", " << size[2] << ") = " << enumToString(error) << "\n";
153     }
154
155     if (error == GL_NO_ERROR) {
156         return true;
157     }
158
159     while (glGetError() != GL_NO_ERROR)
160         ;
161
162     return false;
163 }
164
165
166 /**
167  * Bisect the texture size along an axis.
168  *
169  * It is assumed that the texture exists.
170  */
171 static GLint
172 bisectTextureLevelSizeOES(GLenum target, GLint level, GLint axis, GLint max) {
173     GLint size[3] = {0, 0, 0};
174
175     assert(axis < 3);
176     assert(max >= 0);
177
178     GLint min = 0;
179     while (true) {
180         GLint test = (min + max) / 2;
181         if (test == min) {
182             return min;
183         }
184
185         size[axis] = test;
186
187         if (probeTextureLevelSizeOES(target, level, size)) {
188             min = test;
189         } else {
190             max = test;
191         }
192     }
193 }
194
195
196 /**
197  * Special path to obtain texture size on OpenGL ES, that does not rely on
198  * glGetTexLevelParameteriv
199  */
200 static bool
201 getActiveTextureLevelDescOES(Context &context, GLenum target, GLint level, ImageDesc &desc)
202 {
203     if (target == GL_TEXTURE_1D) {
204         // OpenGL ES does not support 1D textures
205         return false;
206     }
207
208     const GLint size[3] = {1, 1, 1}; 
209     if (!probeTextureLevelSizeOES(target, level, size)) {
210         return false;
211     }
212
213     // XXX: mere guess
214     desc.internalFormat = GL_RGBA;
215
216     GLint maxSize = 0;
217     switch (target) {
218     case GL_TEXTURE_2D:
219         glGetIntegerv(GL_MAX_TEXTURE_SIZE, &maxSize);
220         desc.width = bisectTextureLevelSizeOES(target, level, 0, maxSize);
221         desc.height = bisectTextureLevelSizeOES(target, level, 1, maxSize);
222         desc.depth = 1;
223         break;
224     case GL_TEXTURE_CUBE_MAP:
225     case GL_TEXTURE_CUBE_MAP_POSITIVE_X:
226     case GL_TEXTURE_CUBE_MAP_NEGATIVE_X:
227     case GL_TEXTURE_CUBE_MAP_POSITIVE_Y:
228     case GL_TEXTURE_CUBE_MAP_NEGATIVE_Y:
229     case GL_TEXTURE_CUBE_MAP_POSITIVE_Z:
230     case GL_TEXTURE_CUBE_MAP_NEGATIVE_Z:
231         glGetIntegerv(GL_MAX_CUBE_MAP_TEXTURE_SIZE, &maxSize);
232         desc.width = bisectTextureLevelSizeOES(target, level, 0, maxSize);
233         desc.height = desc.width;
234         desc.depth = 1;
235         break;
236     case GL_TEXTURE_3D_OES:
237         glGetIntegerv(GL_MAX_3D_TEXTURE_SIZE_OES, &maxSize);
238         desc.width = bisectTextureLevelSizeOES(target, level, 0, maxSize);
239         desc.width = bisectTextureLevelSizeOES(target, level, 1, maxSize);
240         desc.depth = bisectTextureLevelSizeOES(target, level, 2, maxSize);
241         break;
242     default:
243         return false;
244     }
245
246     if (0) {
247         std::cerr
248             << enumToString(target) << " "
249             << level << " "
250             << desc.width << "x" << desc.height << "x" << desc.depth
251             << "\n";
252     }
253
254     return desc.valid();
255 }
256
257
258 static inline bool
259 getActiveTextureLevelDesc(Context &context, GLenum target, GLint level, ImageDesc &desc)
260 {
261     assert(target != GL_TEXTURE_CUBE_MAP);
262
263     if (context.ES) {
264         return getActiveTextureLevelDescOES(context, target, level, desc);
265     }
266
267     glGetTexLevelParameteriv(target, level, GL_TEXTURE_INTERNAL_FORMAT, &desc.internalFormat);
268
269     desc.width = 0;
270     glGetTexLevelParameteriv(target, level, GL_TEXTURE_WIDTH, &desc.width);
271
272     if (target == GL_TEXTURE_1D) {
273         desc.height = 1;
274         desc.depth = 1;
275     } else {
276         desc.height = 0;
277         glGetTexLevelParameteriv(target, level, GL_TEXTURE_HEIGHT, &desc.height);
278         if (target != GL_TEXTURE_3D) {
279             desc.depth = 1;
280         } else {
281             desc.depth = 0;
282             glGetTexLevelParameteriv(target, level, GL_TEXTURE_DEPTH, &desc.depth);
283         }
284     }
285
286     return desc.valid();
287 }
288
289
290 static GLenum
291 getTextureBinding(GLenum target)
292 {
293     switch (target) {
294     case GL_TEXTURE_1D:
295         return GL_TEXTURE_BINDING_1D;
296     case GL_TEXTURE_1D_ARRAY:
297         return GL_TEXTURE_BINDING_1D_ARRAY;
298     case GL_TEXTURE_2D:
299         return GL_TEXTURE_BINDING_2D;
300     case GL_TEXTURE_2D_MULTISAMPLE:
301         return GL_TEXTURE_BINDING_2D_MULTISAMPLE;
302     case GL_TEXTURE_2D_ARRAY:
303         return GL_TEXTURE_BINDING_2D_ARRAY;
304     case GL_TEXTURE_RECTANGLE:
305         return GL_TEXTURE_BINDING_RECTANGLE;
306     case GL_TEXTURE_CUBE_MAP:
307     case GL_TEXTURE_CUBE_MAP_POSITIVE_X:
308     case GL_TEXTURE_CUBE_MAP_NEGATIVE_X:
309     case GL_TEXTURE_CUBE_MAP_POSITIVE_Y:
310     case GL_TEXTURE_CUBE_MAP_NEGATIVE_Y:
311     case GL_TEXTURE_CUBE_MAP_POSITIVE_Z:
312     case GL_TEXTURE_CUBE_MAP_NEGATIVE_Z:
313         return GL_TEXTURE_BINDING_CUBE_MAP;
314     case GL_TEXTURE_CUBE_MAP_ARRAY:
315         return GL_TEXTURE_BINDING_CUBE_MAP_ARRAY;
316     case GL_TEXTURE_3D:
317         return GL_TEXTURE_BINDING_3D;
318     default:
319         assert(false);
320         return GL_NONE;
321     }
322 }
323
324
325 /**
326  * OpenGL ES does not support glGetTexImage. Obtain the pixels by attaching the
327  * texture to a framebuffer.
328  */
329 static inline void
330 getTexImageOES(GLenum target, GLint level, ImageDesc &desc, GLubyte *pixels)
331 {
332     memset(pixels, 0x80, desc.height * desc.width * 4);
333
334     GLenum texture_binding = getTextureBinding(target);
335     if (texture_binding == GL_NONE) {
336         return;
337     }
338
339     GLint texture = 0;
340     glGetIntegerv(texture_binding, &texture);
341     if (!texture) {
342         return;
343     }
344
345     GLint prev_fbo = 0;
346     GLuint fbo = 0;
347     glGetIntegerv(GL_FRAMEBUFFER_BINDING, &prev_fbo);
348     glGenFramebuffers(1, &fbo);
349     glBindFramebuffer(GL_FRAMEBUFFER, fbo);
350
351     GLenum status;
352
353     switch (target) {
354     case GL_TEXTURE_2D:
355     case GL_TEXTURE_CUBE_MAP_POSITIVE_X:
356     case GL_TEXTURE_CUBE_MAP_NEGATIVE_X:
357     case GL_TEXTURE_CUBE_MAP_POSITIVE_Y:
358     case GL_TEXTURE_CUBE_MAP_NEGATIVE_Y:
359     case GL_TEXTURE_CUBE_MAP_POSITIVE_Z:
360     case GL_TEXTURE_CUBE_MAP_NEGATIVE_Z:
361         glFramebufferTexture2D(GL_FRAMEBUFFER, GL_COLOR_ATTACHMENT0, GL_TEXTURE_2D, texture, level);
362         status = glCheckFramebufferStatus(GL_FRAMEBUFFER);
363         if (status != GL_FRAMEBUFFER_COMPLETE) {
364             std::cerr << __FUNCTION__ << ": " << enumToString(status) << "\n";
365         }
366         glReadPixels(0, 0, desc.width, desc.height, GL_RGBA, GL_UNSIGNED_BYTE, pixels);
367         break;
368     case GL_TEXTURE_3D_OES:
369         for (int i = 0; i < desc.depth; i++) {
370             glFramebufferTexture3D(GL_FRAMEBUFFER, GL_COLOR_ATTACHMENT0, GL_TEXTURE_3D, texture, level, i);
371             glReadPixels(0, 0, desc.width, desc.height, GL_RGBA, GL_UNSIGNED_BYTE, pixels + 4 * i * desc.width * desc.height);
372         }
373         break;
374     }
375
376     glBindFramebuffer(GL_FRAMEBUFFER, prev_fbo);
377
378     glDeleteFramebuffers(1, &fbo);
379 }
380
381
382 static inline GLboolean
383 isDepthFormat(GLenum internalFormat)
384 {
385    switch (internalFormat) {
386    case GL_DEPTH_COMPONENT:
387    case GL_DEPTH_COMPONENT16:
388    case GL_DEPTH_COMPONENT24:
389    case GL_DEPTH_COMPONENT32:
390    case GL_DEPTH_COMPONENT32F:
391    case GL_DEPTH_COMPONENT32F_NV:
392    case GL_DEPTH_STENCIL:
393    case GL_DEPTH24_STENCIL8:
394    case GL_DEPTH32F_STENCIL8:
395    case GL_DEPTH32F_STENCIL8_NV:
396       return GL_TRUE;
397    }
398    return GL_FALSE;
399 }
400
401
402 static inline void
403 dumpActiveTextureLevel(JSONWriter &json, Context &context, GLenum target, GLint level)
404 {
405     ImageDesc desc;
406     if (!getActiveTextureLevelDesc(context, target, level, desc)) {
407         return;
408     }
409
410     char label[512];
411     GLint active_texture = GL_TEXTURE0;
412     glGetIntegerv(GL_ACTIVE_TEXTURE, &active_texture);
413     snprintf(label, sizeof label, "%s, %s, level = %d",
414              enumToString(active_texture), enumToString(target), level);
415
416     json.beginMember(label);
417
418     GLuint channels;
419     GLenum format;
420     if (!context.ES && isDepthFormat(desc.internalFormat)) {
421        format = GL_DEPTH_COMPONENT;
422        channels = 1;
423     } else {
424        format = GL_RGBA;
425        channels = 4;
426     }
427
428     image::Image *image = new image::Image(desc.width, desc.height*desc.depth, channels, true);
429
430     context.resetPixelPackState();
431
432     if (context.ES) {
433         getTexImageOES(target, level, desc, image->pixels);
434     } else {
435         glGetTexImage(target, level, format, GL_UNSIGNED_BYTE, image->pixels);
436     }
437
438     context.restorePixelPackState();
439
440     json.writeImage(image, formatToString(desc.internalFormat), desc.depth);
441
442     delete image;
443
444     json.endMember(); // label
445 }
446
447
448 static inline void
449 dumpTexture(JSONWriter &json, Context &context, GLenum target, GLenum binding)
450 {
451     GLint texture_binding = 0;
452     glGetIntegerv(binding, &texture_binding);
453     if (!glIsEnabled(target) && !texture_binding) {
454         return;
455     }
456
457     GLint level = 0;
458     do {
459         ImageDesc desc;
460
461         if (target == GL_TEXTURE_CUBE_MAP) {
462             for (int face = 0; face < 6; ++face) {
463                 if (!getActiveTextureLevelDesc(context, GL_TEXTURE_CUBE_MAP_POSITIVE_X + face, level, desc)) {
464                     return;
465                 }
466                 dumpActiveTextureLevel(json, context, GL_TEXTURE_CUBE_MAP_POSITIVE_X + face, level);
467             }
468         } else {
469             if (!getActiveTextureLevelDesc(context, target, level, desc)) {
470                 return;
471             }
472             dumpActiveTextureLevel(json, context, target, level);
473         }
474
475         ++level;
476     } while(true);
477 }
478
479
480 void
481 dumpTextures(JSONWriter &json, Context &context)
482 {
483     json.beginMember("textures");
484     json.beginObject();
485     GLint active_texture = GL_TEXTURE0;
486     glGetIntegerv(GL_ACTIVE_TEXTURE, &active_texture);
487
488     GLint max_texture_coords = 0;
489     glGetIntegerv(GL_MAX_TEXTURE_COORDS, &max_texture_coords);
490     GLint max_combined_texture_image_units = 0;
491     glGetIntegerv(GL_MAX_COMBINED_TEXTURE_IMAGE_UNITS, &max_combined_texture_image_units);
492     GLint max_units = std::max(max_combined_texture_image_units, max_texture_coords);
493
494     /*
495      * At least the Android software GL implementation doesn't return the
496      * proper value for this, but rather returns 0. The GL(ES) specification
497      * mandates a minimum value of 2, so use this as a fall-back value.
498      */
499     max_units = std::max(max_units, 2);
500
501     for (GLint unit = 0; unit < max_units; ++unit) {
502         GLenum texture = GL_TEXTURE0 + unit;
503         glActiveTexture(texture);
504         dumpTexture(json, context, GL_TEXTURE_1D, GL_TEXTURE_BINDING_1D);
505         dumpTexture(json, context, GL_TEXTURE_2D, GL_TEXTURE_BINDING_2D);
506         dumpTexture(json, context, GL_TEXTURE_3D, GL_TEXTURE_BINDING_3D);
507         dumpTexture(json, context, GL_TEXTURE_RECTANGLE, GL_TEXTURE_BINDING_RECTANGLE);
508         dumpTexture(json, context, GL_TEXTURE_CUBE_MAP, GL_TEXTURE_BINDING_CUBE_MAP);
509     }
510     glActiveTexture(active_texture);
511     json.endObject();
512     json.endMember(); // textures
513 }
514
515
516 static bool
517 getDrawableBounds(GLint *width, GLint *height) {
518 #if defined(__linux__)
519     if (dlsym(RTLD_DEFAULT, "eglGetCurrentContext")) {
520         EGLContext currentContext = eglGetCurrentContext();
521         if (currentContext == EGL_NO_CONTEXT) {
522             return false;
523         }
524
525         EGLSurface currentSurface = eglGetCurrentSurface(EGL_DRAW);
526         if (currentSurface == EGL_NO_SURFACE) {
527             return false;
528         }
529
530         EGLDisplay currentDisplay = eglGetCurrentDisplay();
531         if (currentDisplay == EGL_NO_DISPLAY) {
532             return false;
533         }
534
535         if (!eglQuerySurface(currentDisplay, currentSurface, EGL_WIDTH, width) ||
536             !eglQuerySurface(currentDisplay, currentSurface, EGL_HEIGHT, height)) {
537             return false;
538         }
539
540         return true;
541     }
542 #endif
543
544 #if defined(_WIN32)
545
546     HDC hDC = wglGetCurrentDC();
547     if (!hDC) {
548         return false;
549     }
550
551     HWND hWnd = WindowFromDC(hDC);
552     RECT rect;
553
554     if (!GetClientRect(hWnd, &rect)) {
555        return false;
556     }
557
558     *width  = rect.right  - rect.left;
559     *height = rect.bottom - rect.top;
560     return true;
561
562 #elif defined(__APPLE__)
563
564     CGLContextObj ctx = CGLGetCurrentContext();
565     if (ctx == NULL) {
566         return false;
567     }
568
569     CGSConnectionID cid;
570     CGSWindowID wid;
571     CGSSurfaceID sid;
572
573     if (CGLGetSurface(ctx, &cid, &wid, &sid) != kCGLNoError) {
574         return false;
575     }
576
577     CGRect rect;
578
579     if (CGSGetSurfaceBounds(cid, wid, sid, &rect) != 0) {
580         return false;
581     }
582
583     *width = rect.size.width;
584     *height = rect.size.height;
585     return true;
586
587 #elif defined(HAVE_X11)
588
589     Display *display;
590     Drawable drawable;
591     Window root;
592     int x, y;
593     unsigned int w, h, bw, depth;
594
595     display = glXGetCurrentDisplay();
596     if (!display) {
597         return false;
598     }
599
600     drawable = glXGetCurrentDrawable();
601     if (drawable == None) {
602         return false;
603     }
604
605     if (!XGetGeometry(display, drawable, &root, &x, &y, &w, &h, &bw, &depth)) {
606         return false;
607     }
608
609     *width = w;
610     *height = h;
611     return true;
612
613 #else
614
615     return false;
616
617 #endif
618 }
619
620
621 struct TextureTargetBinding
622 {
623     GLenum target;
624     GLenum binding;
625 };
626
627
628 static const GLenum
629 textureTargets[] = {
630     GL_TEXTURE_1D,
631     GL_TEXTURE_2D,
632     GL_TEXTURE_RECTANGLE,
633     GL_TEXTURE_CUBE_MAP,
634     GL_TEXTURE_3D,
635     GL_TEXTURE_2D_MULTISAMPLE,
636     GL_TEXTURE_1D_ARRAY,
637     GL_TEXTURE_2D_ARRAY,
638     GL_TEXTURE_CUBE_MAP_ARRAY,
639 };
640
641
642 static GLenum
643 getTextureTarget(GLint texture)
644 {
645     if (!glIsTexture(texture)) {
646         return GL_NONE;
647     }
648
649     for (unsigned i = 0; i < sizeof(textureTargets)/sizeof(textureTargets[0]); ++i) {
650         GLenum target = textureTargets[i];
651         GLenum binding = getTextureBinding(target);
652
653         while (glGetError() != GL_NO_ERROR)
654             ;
655
656         GLint bound_texture = 0;
657         glGetIntegerv(binding, &bound_texture);
658         glBindTexture(target, texture);
659
660         bool succeeded = glGetError() == GL_NO_ERROR;
661
662         glBindTexture(target, bound_texture);
663
664         if (succeeded) {
665             return target;
666         }
667     }
668
669     return GL_NONE;
670 }
671
672
673 static bool
674 getBoundRenderbufferDesc(Context &context, ImageDesc &desc)
675 {
676     glGetRenderbufferParameteriv(GL_RENDERBUFFER, GL_RENDERBUFFER_WIDTH, &desc.width);
677     glGetRenderbufferParameteriv(GL_RENDERBUFFER, GL_RENDERBUFFER_HEIGHT, &desc.height);
678     desc.depth = 1;
679     
680     glGetRenderbufferParameteriv(GL_RENDERBUFFER, GL_RENDERBUFFER_INTERNAL_FORMAT, &desc.internalFormat);
681     
682     return desc.valid();
683 }
684
685
686 static bool
687 getRenderbufferDesc(Context &context, GLint renderbuffer, ImageDesc &desc)
688 {
689     GLint bound_renderbuffer = 0;
690     glGetIntegerv(GL_RENDERBUFFER_BINDING, &bound_renderbuffer);
691     glBindRenderbuffer(GL_RENDERBUFFER, renderbuffer);
692
693     getBoundRenderbufferDesc(context, desc);
694
695     glBindRenderbuffer(GL_RENDERBUFFER, bound_renderbuffer);
696     
697     return desc.valid();
698 }
699
700
701 static bool
702 getFramebufferAttachmentDesc(Context &context, GLenum target, GLenum attachment, ImageDesc &desc)
703 {
704     GLint object_type = GL_NONE;
705     glGetFramebufferAttachmentParameteriv(target, attachment,
706                                           GL_FRAMEBUFFER_ATTACHMENT_OBJECT_TYPE,
707                                           &object_type);
708     if (object_type == GL_NONE) {
709         return false;
710     }
711
712     GLint object_name = 0;
713     glGetFramebufferAttachmentParameteriv(target, attachment,
714                                           GL_FRAMEBUFFER_ATTACHMENT_OBJECT_NAME,
715                                           &object_name);
716     if (object_name == 0) {
717         return false;
718     }
719
720     if (object_type == GL_RENDERBUFFER) {
721         return getRenderbufferDesc(context, object_name, desc);
722     } else if (object_type == GL_TEXTURE) {
723         GLint texture_face = 0;
724         glGetFramebufferAttachmentParameteriv(target, attachment,
725                                               GL_FRAMEBUFFER_ATTACHMENT_TEXTURE_CUBE_MAP_FACE,
726                                               &texture_face);
727
728         GLint texture_level = 0;
729         glGetFramebufferAttachmentParameteriv(target, attachment,
730                                               GL_FRAMEBUFFER_ATTACHMENT_TEXTURE_LEVEL,
731                                               &texture_level);
732
733         GLint bound_texture = 0;
734         if (texture_face != 0) {
735             glGetIntegerv(GL_TEXTURE_BINDING_CUBE_MAP, &bound_texture);
736             getActiveTextureLevelDesc(context, texture_face, texture_level, desc);
737             glBindTexture(GL_TEXTURE_CUBE_MAP, bound_texture);
738         } else {
739             GLenum texture_target = getTextureTarget(object_name);
740             GLenum texture_binding = getTextureBinding(texture_target);
741             glGetIntegerv(texture_binding, &bound_texture);
742             glBindTexture(texture_target, object_name);
743             getActiveTextureLevelDesc(context, texture_face, texture_level, desc);
744             glBindTexture(texture_binding, bound_texture);
745         }
746
747         return desc.valid();
748     } else {
749         std::cerr << "warning: unexpected GL_FRAMEBUFFER_ATTACHMENT_OBJECT_TYPE = " << object_type << "\n";
750         return false;
751     }
752 }
753
754
755
756 image::Image *
757 getDrawBufferImage() {
758     GLenum format = GL_RGB;
759     GLint channels = _gl_format_channels(format);
760     if (channels > 4) {
761         return NULL;
762     }
763
764     Context context;
765
766     GLenum framebuffer_binding;
767     GLenum framebuffer_target;
768     if (context.ES) {
769         framebuffer_binding = GL_FRAMEBUFFER_BINDING;
770         framebuffer_target = GL_FRAMEBUFFER;
771     } else {
772         framebuffer_binding = GL_DRAW_FRAMEBUFFER_BINDING;
773         framebuffer_target = GL_DRAW_FRAMEBUFFER;
774     }
775
776     GLint draw_framebuffer = 0;
777     glGetIntegerv(framebuffer_binding, &draw_framebuffer);
778
779     GLint draw_buffer = GL_NONE;
780     ImageDesc desc;
781     if (draw_framebuffer) {
782         if (context.ARB_draw_buffers) {
783             glGetIntegerv(GL_DRAW_BUFFER0, &draw_buffer);
784             if (draw_buffer == GL_NONE) {
785                 return NULL;
786             }
787         } else {
788             // GL_COLOR_ATTACHMENT0 is implied
789             draw_buffer = GL_COLOR_ATTACHMENT0;
790         }
791
792         if (!getFramebufferAttachmentDesc(context, framebuffer_target, draw_buffer, desc)) {
793             return NULL;
794         }
795     } else {
796         if (context.ES) {
797             // XXX: Draw buffer is always FRONT for single buffer context, BACK
798             // for double buffered contexts. There is no way to know which (as
799             // GL_DOUBLEBUFFER state is also unavailable), so always assume
800             // double-buffering.
801             draw_buffer = GL_BACK;
802         } else {
803             glGetIntegerv(GL_DRAW_BUFFER, &draw_buffer);
804             if (draw_buffer == GL_NONE) {
805                 return NULL;
806             }
807         }
808
809         if (!getDrawableBounds(&desc.width, &desc.height)) {
810             return NULL;
811         }
812
813         desc.depth = 1;
814     }
815
816     GLenum type = GL_UNSIGNED_BYTE;
817
818 #if DEPTH_AS_RGBA
819     if (format == GL_DEPTH_COMPONENT) {
820         type = GL_UNSIGNED_INT;
821         channels = 4;
822     }
823 #endif
824
825     image::Image *image = new image::Image(desc.width, desc.height, channels, true);
826     if (!image) {
827         return NULL;
828     }
829
830     while (glGetError() != GL_NO_ERROR) {}
831
832     GLint read_framebuffer = 0;
833     GLint read_buffer = GL_NONE;
834     if (!context.ES) {
835         glGetIntegerv(GL_READ_FRAMEBUFFER_BINDING, &read_framebuffer);
836         glBindFramebuffer(GL_READ_FRAMEBUFFER, draw_framebuffer);
837
838         glGetIntegerv(GL_READ_BUFFER, &read_buffer);
839         glReadBuffer(draw_buffer);
840     }
841
842     // TODO: reset imaging state too
843     context.resetPixelPackState();
844
845     glReadPixels(0, 0, desc.width, desc.height, format, type, image->pixels);
846
847     context.restorePixelPackState();
848
849     if (!context.ES) {
850         glReadBuffer(read_buffer);
851         glBindFramebuffer(GL_READ_FRAMEBUFFER, read_framebuffer);
852     }
853
854     GLenum error = glGetError();
855     if (error != GL_NO_ERROR) {
856         do {
857             std::cerr << "warning: " << enumToString(error) << " while getting snapshot\n";
858             error = glGetError();
859         } while(error != GL_NO_ERROR);
860         delete image;
861         return NULL;
862     }
863      
864     return image;
865 }
866
867
868 /**
869  * Dump the image of the currently bound read buffer.
870  */
871 static inline void
872 dumpReadBufferImage(JSONWriter &json, GLint width, GLint height, GLenum format,
873                     GLint internalFormat = GL_NONE)
874 {
875     GLint channels = _gl_format_channels(format);
876
877     if (internalFormat == GL_NONE) {
878         internalFormat = format;
879     }
880
881     Context context;
882
883     GLenum type = GL_UNSIGNED_BYTE;
884
885 #if DEPTH_AS_RGBA
886     if (format == GL_DEPTH_COMPONENT) {
887         type = GL_UNSIGNED_INT;
888         channels = 4;
889     }
890 #endif
891
892     image::Image *image = new image::Image(width, height, channels, true);
893
894     // TODO: reset imaging state too
895     context.resetPixelPackState();
896
897     glReadPixels(0, 0, width, height, format, type, image->pixels);
898
899     context.restorePixelPackState();
900
901     json.writeImage(image, formatToString(internalFormat));
902
903     delete image;
904 }
905
906
907 static inline GLuint
908 downsampledFramebuffer(Context &context,
909                        GLuint oldFbo, GLint drawbuffer,
910                        GLint colorRb, GLint depthRb, GLint stencilRb,
911                        GLuint *rbs, GLint *numRbs)
912 {
913     GLuint fbo;
914
915
916     *numRbs = 0;
917
918     glGenFramebuffers(1, &fbo);
919     glBindFramebuffer(GL_FRAMEBUFFER, fbo);
920
921     {
922         // color buffer
923         ImageDesc desc;
924         glBindRenderbuffer(GL_RENDERBUFFER, colorRb);
925         getBoundRenderbufferDesc(context, desc);
926
927         glGenRenderbuffers(1, &rbs[*numRbs]);
928         glBindRenderbuffer(GL_RENDERBUFFER, rbs[*numRbs]);
929         glRenderbufferStorage(GL_RENDERBUFFER, desc.internalFormat, desc.width, desc.height);
930         glFramebufferRenderbuffer(GL_FRAMEBUFFER, drawbuffer,
931                                   GL_RENDERBUFFER, rbs[*numRbs]);
932
933         glBindFramebuffer(GL_READ_FRAMEBUFFER, oldFbo);
934         glBindFramebuffer(GL_DRAW_FRAMEBUFFER, fbo);
935         glDrawBuffer(drawbuffer);
936         glReadBuffer(drawbuffer);
937         glBlitFramebuffer(0, 0, desc.width, desc.height, 0, 0, desc.width, desc.height,
938                           GL_COLOR_BUFFER_BIT, GL_NEAREST);
939         glBindFramebuffer(GL_FRAMEBUFFER, fbo);
940         ++*numRbs;
941     }
942
943     if (stencilRb == depthRb && stencilRb) {
944         //combined depth and stencil buffer
945         ImageDesc desc;
946         glBindRenderbuffer(GL_RENDERBUFFER, depthRb);
947         getBoundRenderbufferDesc(context, desc);
948
949         glGenRenderbuffers(1, &rbs[*numRbs]);
950         glBindRenderbuffer(GL_RENDERBUFFER, rbs[*numRbs]);
951         glRenderbufferStorage(GL_RENDERBUFFER, desc.internalFormat, desc.width, desc.height);
952         glFramebufferRenderbuffer(GL_FRAMEBUFFER, GL_DEPTH_STENCIL_ATTACHMENT,
953                                   GL_RENDERBUFFER, rbs[*numRbs]);
954         glBindFramebuffer(GL_READ_FRAMEBUFFER, oldFbo);
955         glBindFramebuffer(GL_DRAW_FRAMEBUFFER, fbo);
956         glBlitFramebuffer(0, 0, desc.width, desc.height, 0, 0, desc.width, desc.height,
957                           GL_DEPTH_BUFFER_BIT | GL_STENCIL_BUFFER_BIT, GL_NEAREST);
958         glBindFramebuffer(GL_FRAMEBUFFER, fbo);
959         ++*numRbs;
960     } else {
961         if (depthRb) {
962             ImageDesc desc;
963             glBindRenderbuffer(GL_RENDERBUFFER, depthRb);
964             getBoundRenderbufferDesc(context, desc);
965
966             glGenRenderbuffers(1, &rbs[*numRbs]);
967             glBindRenderbuffer(GL_RENDERBUFFER, rbs[*numRbs]);
968             glRenderbufferStorage(GL_RENDERBUFFER, desc.internalFormat, desc.width, desc.height);
969             glFramebufferRenderbuffer(GL_FRAMEBUFFER,
970                                       GL_DEPTH_ATTACHMENT,
971                                       GL_RENDERBUFFER, rbs[*numRbs]);
972             glBindFramebuffer(GL_READ_FRAMEBUFFER, oldFbo);
973             glBindFramebuffer(GL_DRAW_FRAMEBUFFER, fbo);
974             glDrawBuffer(GL_DEPTH_ATTACHMENT);
975             glReadBuffer(GL_DEPTH_ATTACHMENT);
976             glBlitFramebuffer(0, 0, desc.width, desc.height, 0, 0, desc.width, desc.height,
977                               GL_DEPTH_BUFFER_BIT, GL_NEAREST);
978             ++*numRbs;
979         }
980         if (stencilRb) {
981             ImageDesc desc;
982             glBindRenderbuffer(GL_RENDERBUFFER, stencilRb);
983             getBoundRenderbufferDesc(context, desc);
984
985             glGenRenderbuffers(1, &rbs[*numRbs]);
986             glBindRenderbuffer(GL_RENDERBUFFER, rbs[*numRbs]);
987             glRenderbufferStorage(GL_RENDERBUFFER, desc.internalFormat, desc.width, desc.height);
988             glFramebufferRenderbuffer(GL_FRAMEBUFFER,
989                                       GL_STENCIL_ATTACHMENT,
990                                       GL_RENDERBUFFER, rbs[*numRbs]);
991             glBindFramebuffer(GL_READ_FRAMEBUFFER, oldFbo);
992             glBindFramebuffer(GL_DRAW_FRAMEBUFFER, fbo);
993             glDrawBuffer(GL_STENCIL_ATTACHMENT);
994             glReadBuffer(GL_STENCIL_ATTACHMENT);
995             glBlitFramebuffer(0, 0, desc.width, desc.height, 0, 0, desc.width, desc.height,
996                               GL_STENCIL_BUFFER_BIT, GL_NEAREST);
997             ++*numRbs;
998         }
999     }
1000
1001     return fbo;
1002 }
1003
1004
1005 /**
1006  * Dump images of current draw drawable/window.
1007  */
1008 static void
1009 dumpDrawableImages(JSONWriter &json, Context &context)
1010 {
1011     GLint width, height;
1012
1013     if (!getDrawableBounds(&width, &height)) {
1014         return;
1015     }
1016
1017     GLint draw_buffer = GL_NONE;
1018     if (context.ES) {
1019         // XXX: Draw buffer is always FRONT for single buffer context, BACK for
1020         // double buffered contexts. There is no way to know which (as
1021         // GL_DOUBLEBUFFER state is also unavailable), so always assume
1022         // double-buffering.
1023         draw_buffer = GL_BACK;
1024     } else {
1025         glGetIntegerv(GL_DRAW_BUFFER, &draw_buffer);
1026     }
1027
1028     if (draw_buffer != GL_NONE) {
1029         // Read from current draw buffer
1030         GLint read_buffer = GL_NONE;
1031         if (!context.ES) {
1032             glGetIntegerv(GL_READ_BUFFER, &read_buffer);
1033             glReadBuffer(draw_buffer);
1034         }
1035
1036         GLint alpha_bits = 0;
1037 #if 0
1038         // XXX: Ignore alpha until we are able to match the traced visual
1039         glGetIntegerv(GL_ALPHA_BITS, &alpha_bits);
1040 #endif
1041         GLenum format = alpha_bits ? GL_RGBA : GL_RGB;
1042         json.beginMember(enumToString(draw_buffer));
1043         dumpReadBufferImage(json, width, height, format);
1044         json.endMember();
1045
1046         // Restore original read buffer
1047         if (!context.ES) {
1048             glReadBuffer(read_buffer);
1049         }
1050     }
1051
1052     if (!context.ES) {
1053         GLint depth_bits = 0;
1054         glGetIntegerv(GL_DEPTH_BITS, &depth_bits);
1055         if (depth_bits) {
1056             json.beginMember("GL_DEPTH_COMPONENT");
1057             dumpReadBufferImage(json, width, height, GL_DEPTH_COMPONENT);
1058             json.endMember();
1059         }
1060
1061         GLint stencil_bits = 0;
1062         glGetIntegerv(GL_STENCIL_BITS, &stencil_bits);
1063         if (stencil_bits) {
1064             json.beginMember("GL_STENCIL_INDEX");
1065             dumpReadBufferImage(json, width, height, GL_STENCIL_INDEX);
1066             json.endMember();
1067         }
1068     }
1069 }
1070
1071
1072 /**
1073  * Dump the specified framebuffer attachment.
1074  *
1075  * In the case of a color attachment, it assumes it is already bound for read.
1076  */
1077 static void
1078 dumpFramebufferAttachment(JSONWriter &json, Context &context, GLenum target, GLenum attachment, GLenum format)
1079 {
1080     ImageDesc desc;
1081     if (!getFramebufferAttachmentDesc(context, target, attachment, desc)) {
1082         return;
1083     }
1084
1085     json.beginMember(enumToString(attachment));
1086     dumpReadBufferImage(json, desc.width, desc.height, format, desc.internalFormat);
1087     json.endMember();
1088 }
1089
1090
1091 static void
1092 dumpFramebufferAttachments(JSONWriter &json, Context &context, GLenum target)
1093 {
1094     GLint read_framebuffer = 0;
1095     glGetIntegerv(GL_READ_FRAMEBUFFER_BINDING, &read_framebuffer);
1096
1097     GLint read_buffer = GL_NONE;
1098     glGetIntegerv(GL_READ_BUFFER, &read_buffer);
1099
1100     GLint max_draw_buffers = 1;
1101     glGetIntegerv(GL_MAX_DRAW_BUFFERS, &max_draw_buffers);
1102     GLint max_color_attachments = 0;
1103     glGetIntegerv(GL_MAX_COLOR_ATTACHMENTS, &max_color_attachments);
1104
1105     for (GLint i = 0; i < max_draw_buffers; ++i) {
1106         GLint draw_buffer = GL_NONE;
1107         glGetIntegerv(GL_DRAW_BUFFER0 + i, &draw_buffer);
1108         if (draw_buffer != GL_NONE) {
1109             glReadBuffer(draw_buffer);
1110             GLint attachment;
1111             if (draw_buffer >= GL_COLOR_ATTACHMENT0 && draw_buffer < GL_COLOR_ATTACHMENT0 + max_color_attachments) {
1112                 attachment = draw_buffer;
1113             } else {
1114                 std::cerr << "warning: unexpected GL_DRAW_BUFFER" << i << " = " << draw_buffer << "\n";
1115                 attachment = GL_COLOR_ATTACHMENT0;
1116             }
1117             GLint alpha_size = 0;
1118             glGetFramebufferAttachmentParameteriv(target, attachment,
1119                                                   GL_FRAMEBUFFER_ATTACHMENT_ALPHA_SIZE,
1120                                                   &alpha_size);
1121             GLenum format = alpha_size ? GL_RGBA : GL_RGB;
1122             dumpFramebufferAttachment(json, context, target, attachment, format);
1123         }
1124     }
1125
1126     glReadBuffer(read_buffer);
1127
1128     if (!context.ES) {
1129         dumpFramebufferAttachment(json, context, target, GL_DEPTH_ATTACHMENT, GL_DEPTH_COMPONENT);
1130         dumpFramebufferAttachment(json, context, target, GL_STENCIL_ATTACHMENT, GL_STENCIL_INDEX);
1131     }
1132
1133     glBindFramebuffer(GL_READ_FRAMEBUFFER, read_framebuffer);
1134 }
1135
1136
1137 void
1138 dumpFramebuffer(JSONWriter &json, Context &context)
1139 {
1140     json.beginMember("framebuffer");
1141     json.beginObject();
1142
1143     GLint boundDrawFbo = 0, boundReadFbo = 0;
1144     glGetIntegerv(GL_DRAW_FRAMEBUFFER_BINDING, &boundDrawFbo);
1145     glGetIntegerv(GL_READ_FRAMEBUFFER_BINDING, &boundReadFbo);
1146     if (!boundDrawFbo) {
1147         dumpDrawableImages(json, context);
1148     } else if (context.ES) {
1149         dumpFramebufferAttachments(json, context, GL_FRAMEBUFFER);
1150     } else {
1151         GLint colorRb = 0, stencilRb = 0, depthRb = 0;
1152         GLint draw_buffer0 = GL_NONE;
1153         glGetIntegerv(GL_DRAW_BUFFER0, &draw_buffer0);
1154         bool multisample = false;
1155
1156         GLint boundRb = 0;
1157         glGetIntegerv(GL_RENDERBUFFER_BINDING, &boundRb);
1158
1159         GLint object_type;
1160         glGetFramebufferAttachmentParameteriv(GL_DRAW_FRAMEBUFFER, draw_buffer0, GL_FRAMEBUFFER_ATTACHMENT_OBJECT_TYPE, &object_type);
1161         if (object_type == GL_RENDERBUFFER) {
1162             glGetFramebufferAttachmentParameteriv(GL_DRAW_FRAMEBUFFER, draw_buffer0, GL_FRAMEBUFFER_ATTACHMENT_OBJECT_NAME, &colorRb);
1163             glBindRenderbuffer(GL_RENDERBUFFER, colorRb);
1164             GLint samples = 0;
1165             glGetRenderbufferParameteriv(GL_RENDERBUFFER, GL_RENDERBUFFER_SAMPLES, &samples);
1166             if (samples) {
1167                 multisample = true;
1168             }
1169         }
1170
1171         glGetFramebufferAttachmentParameteriv(GL_DRAW_FRAMEBUFFER, GL_DEPTH_ATTACHMENT, GL_FRAMEBUFFER_ATTACHMENT_OBJECT_TYPE, &object_type);
1172         if (object_type == GL_RENDERBUFFER) {
1173             glGetFramebufferAttachmentParameteriv(GL_DRAW_FRAMEBUFFER, GL_DEPTH_ATTACHMENT, GL_FRAMEBUFFER_ATTACHMENT_OBJECT_NAME, &depthRb);
1174             glBindRenderbuffer(GL_RENDERBUFFER, depthRb);
1175             GLint samples = 0;
1176             glGetRenderbufferParameteriv(GL_RENDERBUFFER, GL_RENDERBUFFER_SAMPLES, &samples);
1177             if (samples) {
1178                 multisample = true;
1179             }
1180         }
1181
1182         glGetFramebufferAttachmentParameteriv(GL_DRAW_FRAMEBUFFER, GL_STENCIL_ATTACHMENT, GL_FRAMEBUFFER_ATTACHMENT_OBJECT_TYPE, &object_type);
1183         if (object_type == GL_RENDERBUFFER) {
1184             glGetFramebufferAttachmentParameteriv(GL_DRAW_FRAMEBUFFER, GL_STENCIL_ATTACHMENT, GL_FRAMEBUFFER_ATTACHMENT_OBJECT_NAME, &stencilRb);
1185             glBindRenderbuffer(GL_RENDERBUFFER, stencilRb);
1186             GLint samples = 0;
1187             glGetRenderbufferParameteriv(GL_RENDERBUFFER, GL_RENDERBUFFER_SAMPLES, &samples);
1188             if (samples) {
1189                 multisample = true;
1190             }
1191         }
1192
1193         glBindRenderbuffer(GL_RENDERBUFFER, boundRb);
1194
1195         GLuint rbs[3];
1196         GLint numRbs = 0;
1197         GLuint fboCopy = 0;
1198
1199         if (multisample) {
1200             // glReadPixels doesnt support multisampled buffers so we need
1201             // to blit the fbo to a temporary one
1202             fboCopy = downsampledFramebuffer(context,
1203                                              boundDrawFbo, draw_buffer0,
1204                                              colorRb, depthRb, stencilRb,
1205                                              rbs, &numRbs);
1206         }
1207
1208         dumpFramebufferAttachments(json, context, GL_DRAW_FRAMEBUFFER);
1209
1210         if (multisample) {
1211             glBindRenderbuffer(GL_RENDERBUFFER_BINDING, boundRb);
1212             glDeleteRenderbuffers(numRbs, rbs);
1213             glDeleteFramebuffers(1, &fboCopy);
1214         }
1215
1216         glBindFramebuffer(GL_READ_FRAMEBUFFER, boundReadFbo);
1217         glBindFramebuffer(GL_DRAW_FRAMEBUFFER, boundDrawFbo);
1218     }
1219
1220     json.endObject();
1221     json.endMember(); // framebuffer
1222 }
1223
1224
1225 } /* namespace glstate */