1 ##########################################################################
3 # Copyright 2010 VMware, Inc.
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:
13 # The above copyright notice and this permission notice shall be included in
14 # all copies or substantial portions of the Software.
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
24 ##########################################################################/
27 """GL retracer generator."""
32 from retrace import Retracer
35 class GlRetracer(Retracer):
37 def retrace_function(self, function):
38 Retracer.retrace_function(self, function)
40 array_pointer_function_names = set((
48 "glSecondaryColorPointer",
50 "glInterleavedArrays",
52 #"glVertexPointerEXT",
53 #"glNormalPointerEXT",
56 #"glTexCoordPointerEXT",
57 #"glEdgeFlagPointerEXT",
58 #"glFogCoordPointerEXT",
59 #"glSecondaryColorPointerEXT",
61 #"glVertexAttribPointer",
62 #"glVertexAttribPointerARB",
63 #"glVertexAttribPointerNV",
64 #"glVertexAttribLPointer",
66 #"glMatrixIndexPointerARB",
69 draw_array_function_names = set([
72 "glDrawArraysIndirect",
73 "glDrawArraysInstanced",
74 "glDrawArraysInstancedARB",
75 "glDrawArraysInstancedEXT",
76 "glDrawMeshArraysSUN",
78 "glMultiDrawArraysEXT",
79 "glMultiModeDrawArraysIBM",
82 draw_elements_function_names = set([
84 "glDrawElementsBaseVertex",
85 "glDrawElementsIndirect",
86 "glDrawElementsInstanced",
87 "glDrawElementsInstancedARB",
88 "glDrawElementsInstancedBaseVertex",
89 "glDrawElementsInstancedEXT",
90 "glDrawRangeElements",
91 "glDrawRangeElementsBaseVertex",
92 "glDrawRangeElementsEXT",
93 #"glMultiDrawElements",
94 #"glMultiDrawElementsBaseVertex",
95 #"glMultiDrawElementsEXT",
96 #"glMultiModeDrawElementsIBM",
99 def retrace_function_body(self, function):
100 is_array_pointer = function.name in self.array_pointer_function_names
101 is_draw_array = function.name in self.draw_array_function_names
102 is_draw_elements = function.name in self.draw_elements_function_names
104 if is_array_pointer or is_draw_array or is_draw_elements:
105 print ' if (Trace::Parser::version < 1) {'
107 if is_array_pointer or is_draw_array:
108 print ' GLint __array_buffer = 0;'
109 print ' glGetIntegerv(GL_ARRAY_BUFFER_BINDING, &__array_buffer);'
110 print ' if (!__array_buffer) {'
111 self.fail_function(function)
115 print ' GLint __element_array_buffer = 0;'
116 print ' glGetIntegerv(GL_ELEMENT_ARRAY_BUFFER_BINDING, &__element_array_buffer);'
117 print ' if (!__element_array_buffer) {'
118 self.fail_function(function)
123 Retracer.retrace_function_body(self, function)
125 def call_function(self, function):
126 if function.name == "glViewport":
127 print ' if (x + width > __window_width) {'
128 print ' __window_width = x + width;'
129 print ' __reshape_window = true;'
131 print ' if (y + height > __window_height) {'
132 print ' __window_height = y + height;'
133 print ' __reshape_window = true;'
136 if function.name == "glEnd":
137 print ' insideGlBeginEnd = false;'
139 Retracer.call_function(self, function)
141 if function.name == "glBegin":
142 print ' insideGlBeginEnd = true;'
144 # glGetError is not allowed inside glBegin/glEnd
145 print ' checkGlError();'
147 pointer_function_names = set([
149 #"glColorPointerEXT",
151 #"glEdgeFlagPointerEXT",
153 #"glFogCoordPointerEXT",
155 #"glIndexPointerEXT",
156 #"glMatrixIndexPointerARB",
158 #"glNormalPointerEXT",
159 "glSecondaryColorPointer",
160 #"glSecondaryColorPointerEXT",
162 #"glTexCoordPointerEXT",
163 #"glVertexAttribLPointer",
164 #"glVertexAttribPointer",
165 #"glVertexAttribPointerARB",
166 #"glVertexAttribPointerNV",
168 #"glVertexPointerEXT",
171 def extract_arg(self, function, arg, arg_type, lvalue, rvalue):
172 if function.name in self.pointer_function_names and arg.name == 'pointer':
173 print ' %s = %s.blob();' % (lvalue, rvalue)
176 if function.name in self.draw_elements_function_names and arg.name == 'indices':
177 print ' %s = %s.blob();' % (lvalue, rvalue)
180 if function.name.startswith('glUniform') and function.args[0].name == arg.name == 'location':
181 print ' GLint program = -1;'
182 print ' glGetIntegerv(GL_CURRENT_PROGRAM, &program);'
184 Retracer.extract_arg(self, function, arg, arg_type, lvalue, rvalue)
187 if __name__ == '__main__':
195 #include "glproc.hpp"
198 static bool double_buffer = false;
199 static bool insideGlBeginEnd = false;
201 static int __window_width = 256, __window_height = 256;
202 bool __reshape_window = false;
204 unsigned __frame = 0;
205 long long __startTime = 0;
208 bool __benchmark = false;
209 const char *__compare_prefix = NULL;
210 const char *__snapshot_prefix = NULL;
215 if (__benchmark || insideGlBeginEnd) {
219 GLenum error = glGetError();
220 if (error == GL_NO_ERROR) {
224 std::cerr << "warning: glGetError() = ";
226 case GL_INVALID_ENUM:
227 std::cerr << "GL_INVALID_ENUM";
229 case GL_INVALID_VALUE:
230 std::cerr << "GL_INVALID_VALUE";
232 case GL_INVALID_OPERATION:
233 std::cerr << "GL_INVALID_OPERATION";
235 case GL_STACK_OVERFLOW:
236 std::cerr << "GL_STACK_OVERFLOW";
238 case GL_STACK_UNDERFLOW:
239 std::cerr << "GL_STACK_UNDERFLOW";
241 case GL_OUT_OF_MEMORY:
242 std::cerr << "GL_OUT_OF_MEMORY";
244 case GL_INVALID_FRAMEBUFFER_OPERATION:
245 std::cerr << "GL_INVALID_FRAMEBUFFER_OPERATION";
247 case GL_TABLE_TOO_LARGE:
248 std::cerr << "GL_TABLE_TOO_LARGE";
258 retracer = GlRetracer()
259 retracer.retrace_api(glapi.glapi)
262 static Trace::Parser parser;
264 static void display_noop(void) {
269 static void snapshot(Image::Image &image) {
270 GLint drawbuffer = double_buffer ? GL_BACK : GL_FRONT;
271 GLint readbuffer = double_buffer ? GL_BACK : GL_FRONT;
272 glGetIntegerv(GL_READ_BUFFER, &drawbuffer);
273 glGetIntegerv(GL_READ_BUFFER, &readbuffer);
274 glReadBuffer(drawbuffer);
275 glReadPixels(0, 0, image.width, image.height, GL_RGBA, GL_UNSIGNED_BYTE, image.pixels);
277 glReadBuffer(readbuffer);
280 static void frame_complete(void) {
283 if (!__reshape_window && (__snapshot_prefix || __compare_prefix)) {
284 Image::Image *ref = NULL;
285 if (__compare_prefix) {
286 char filename[PATH_MAX];
287 snprintf(filename, sizeof filename, "%s%04u.png", __compare_prefix, __frame);
288 ref = Image::readPNG(filename);
293 std::cout << "Read " << filename << "\n";
296 Image::Image src(__window_width, __window_height, true);
299 if (__snapshot_prefix) {
300 char filename[PATH_MAX];
301 snprintf(filename, sizeof filename, "%s%04u.png", __snapshot_prefix, __frame);
302 if (src.writePNG(filename) && verbosity >= 0) {
303 std::cout << "Wrote " << filename << "\n";
308 std::cout << "Frame " << __frame << " average precision of " << src.compare(*ref) << " bits\n";
315 static void display(void) {
318 while ((call = parser.parse_call())) {
319 const std::string &name = call->name();
321 if ((name[0] == 'w' && name[1] == 'g' && name[2] == 'l') ||
322 (name[0] == 'g' && name[1] == 'l' && name[2] == 'X')) {
323 // XXX: We ignore the majority of the OS-specific calls for now
324 if (name == "glXSwapBuffers" ||
325 name == "wglSwapBuffers") {
326 if (verbosity >= 1) {
341 if (name == "glFlush") {
342 if (!double_buffer) {
353 // Reached the end of trace
356 long long endTime = OS::GetTime();
357 float timeInterval = (endTime - __startTime) * 1.0E-6;
360 "Rendered " << __frame << " frames"
361 " in " << timeInterval << " secs,"
362 " average of " << (__frame/timeInterval) << " fps\n";
365 glutDisplayFunc(&display_noop);
372 static void idle(void) {
373 if (__reshape_window) {
374 // XXX: doesn't quite work
375 glutReshapeWindow(__window_width, __window_height);
376 __reshape_window = false;
381 static void usage(void) {
383 "Usage: glretrace [OPTION] TRACE\n"
386 " -b benchmark (no glgeterror; no messages)\n"
387 " -c PREFIX compare against snapshots\n"
388 " -db use a double buffer visual\n"
389 " -s PREFIX take snapshots\n"
390 " -v verbose output\n"
391 " -w wait on final frame\n";
394 int main(int argc, char **argv)
398 for (i = 1; i < argc; ++i) {
399 const char *arg = argv[i];
405 if (!strcmp(arg, "--")) {
407 } else if (!strcmp(arg, "-b")) {
410 } else if (!strcmp(arg, "-c")) {
411 __compare_prefix = argv[++i];
412 } else if (!strcmp(arg, "-db")) {
413 double_buffer = true;
414 } else if (!strcmp(arg, "--help")) {
417 } else if (!strcmp(arg, "-s")) {
418 __snapshot_prefix = argv[++i];
419 } else if (!strcmp(arg, "-v")) {
421 } else if (!strcmp(arg, "-w")) {
424 std::cerr << "error: unknown option " << arg << "\n";
430 glutInit(&argc, argv);
431 glutInitWindowPosition(0, 0);
432 glutInitWindowSize(__window_width, __window_height);
433 glutInitDisplayMode(GLUT_DEPTH | GLUT_RGB | (double_buffer ? GLUT_DOUBLE : GLUT_SINGLE));
434 glutCreateWindow(argv[0]);
436 glutDisplayFunc(&display);
439 for (GLuint h = 0; h < 1024; ++h) {
443 for ( ; i < argc; ++i) {
444 if (parser.open(argv[i])) {
445 __startTime = OS::GetTime();