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",
65 "glVertexAttribLPointerEXT",
67 #"glMatrixIndexPointerARB",
70 draw_array_function_names = set([
73 "glDrawArraysIndirect",
74 "glDrawArraysInstanced",
75 "glDrawArraysInstancedARB",
76 "glDrawArraysInstancedEXT",
77 "glDrawMeshArraysSUN",
79 "glMultiDrawArraysEXT",
80 "glMultiModeDrawArraysIBM",
83 draw_elements_function_names = set([
85 "glDrawElementsBaseVertex",
86 "glDrawElementsIndirect",
87 "glDrawElementsInstanced",
88 "glDrawElementsInstancedARB",
89 "glDrawElementsInstancedBaseVertex",
90 "glDrawElementsInstancedEXT",
91 "glDrawRangeElements",
92 "glDrawRangeElementsBaseVertex",
93 "glDrawRangeElementsEXT",
94 #"glMultiDrawElements",
95 #"glMultiDrawElementsBaseVertex",
96 #"glMultiDrawElementsEXT",
97 #"glMultiModeDrawElementsIBM",
100 def retrace_function_body(self, function):
101 is_array_pointer = function.name in self.array_pointer_function_names
102 is_draw_array = function.name in self.draw_array_function_names
103 is_draw_elements = function.name in self.draw_elements_function_names
105 if is_array_pointer or is_draw_array or is_draw_elements:
106 print ' if (Trace::Parser::version < 1) {'
108 if is_array_pointer or is_draw_array:
109 print ' GLint __array_buffer = 0;'
110 print ' glGetIntegerv(GL_ARRAY_BUFFER_BINDING, &__array_buffer);'
111 print ' if (!__array_buffer) {'
112 self.fail_function(function)
116 print ' GLint __element_array_buffer = 0;'
117 print ' glGetIntegerv(GL_ELEMENT_ARRAY_BUFFER_BINDING, &__element_array_buffer);'
118 print ' if (!__element_array_buffer) {'
119 self.fail_function(function)
124 Retracer.retrace_function_body(self, function)
126 def call_function(self, function):
127 if function.name == "glViewport":
128 print ' if (x + width > __window_width) {'
129 print ' __window_width = x + width;'
130 print ' __reshape_window = true;'
132 print ' if (y + height > __window_height) {'
133 print ' __window_height = y + height;'
134 print ' __reshape_window = true;'
137 if function.name == "glEnd":
138 print ' insideGlBeginEnd = false;'
140 Retracer.call_function(self, function)
142 if function.name == "glBegin":
143 print ' insideGlBeginEnd = true;'
145 # glGetError is not allowed inside glBegin/glEnd
146 print ' checkGlError();'
148 def extract_arg(self, function, arg, arg_type, lvalue, rvalue):
149 if function.name in self.array_pointer_function_names and arg.name == 'pointer':
150 print ' %s = %s.blob();' % (lvalue, rvalue)
153 if function.name in self.draw_elements_function_names and arg.name == 'indices':
154 print ' %s = %s.blob();' % (lvalue, rvalue)
157 if function.name.startswith('glUniform') and function.args[0].name == arg.name == 'location':
158 print ' GLint program = -1;'
159 print ' glGetIntegerv(GL_CURRENT_PROGRAM, &program);'
161 Retracer.extract_arg(self, function, arg, arg_type, lvalue, rvalue)
164 if __name__ == '__main__':
170 #include "glproc.hpp"
171 #include "glstate.hpp"
174 static bool double_buffer = false;
175 static bool insideGlBeginEnd = false;
177 static int __window_width = 256, __window_height = 256;
178 bool __reshape_window = false;
180 unsigned __frame = 0;
181 long long __startTime = 0;
184 bool __benchmark = false;
185 const char *__compare_prefix = NULL;
186 const char *__snapshot_prefix = NULL;
188 unsigned __dump_state = ~0;
193 if (__benchmark || insideGlBeginEnd) {
197 GLenum error = glGetError();
198 if (error == GL_NO_ERROR) {
202 std::cerr << "warning: glGetError() = ";
204 case GL_INVALID_ENUM:
205 std::cerr << "GL_INVALID_ENUM";
207 case GL_INVALID_VALUE:
208 std::cerr << "GL_INVALID_VALUE";
210 case GL_INVALID_OPERATION:
211 std::cerr << "GL_INVALID_OPERATION";
213 case GL_STACK_OVERFLOW:
214 std::cerr << "GL_STACK_OVERFLOW";
216 case GL_STACK_UNDERFLOW:
217 std::cerr << "GL_STACK_UNDERFLOW";
219 case GL_OUT_OF_MEMORY:
220 std::cerr << "GL_OUT_OF_MEMORY";
222 case GL_INVALID_FRAMEBUFFER_OPERATION:
223 std::cerr << "GL_INVALID_FRAMEBUFFER_OPERATION";
225 case GL_TABLE_TOO_LARGE:
226 std::cerr << "GL_TABLE_TOO_LARGE";
236 retracer = GlRetracer()
237 retracer.retrace_api(glapi.glapi)
240 static Trace::Parser parser;
241 static glws::WindowSystem *__ws = NULL;
242 static glws::Visual *__visual = NULL;
243 static glws::Drawable *__drawable = NULL;
244 static glws::Context *__context = NULL;
248 static void snapshot(Image::Image &image) {
249 GLint drawbuffer = double_buffer ? GL_BACK : GL_FRONT;
250 GLint readbuffer = double_buffer ? GL_BACK : GL_FRONT;
251 glGetIntegerv(GL_READ_BUFFER, &drawbuffer);
252 glGetIntegerv(GL_READ_BUFFER, &readbuffer);
253 glReadBuffer(drawbuffer);
254 glReadPixels(0, 0, image.width, image.height, GL_RGBA, GL_UNSIGNED_BYTE, image.pixels);
256 glReadBuffer(readbuffer);
259 static void frame_complete(void) {
262 if (!__reshape_window && (__snapshot_prefix || __compare_prefix)) {
263 Image::Image *ref = NULL;
264 if (__compare_prefix) {
265 char filename[PATH_MAX];
266 snprintf(filename, sizeof filename, "%s%04u.png", __compare_prefix, __frame);
267 ref = Image::readPNG(filename);
272 std::cout << "Read " << filename << "\n";
275 Image::Image src(__window_width, __window_height, true);
278 if (__snapshot_prefix) {
279 char filename[PATH_MAX];
280 snprintf(filename, sizeof filename, "%s%04u.png", __snapshot_prefix, __frame);
281 if (src.writePNG(filename) && verbosity >= 0) {
282 std::cout << "Wrote " << filename << "\n";
287 std::cout << "Frame " << __frame << " average precision of " << src.compare(*ref) << " bits\n";
292 if (__reshape_window) {
293 // XXX: doesn't quite work
294 __drawable->resize(__window_width, __window_height);
295 __reshape_window = false;
298 __ws->processEvents();
301 static void display(void) {
304 while ((call = parser.parse_call())) {
305 const std::string &name = call->name();
307 if (call->no == __dump_state) {
308 state_dump(std::cout);
312 if ((name[0] == 'w' && name[1] == 'g' && name[2] == 'l') ||
313 (name[0] == 'g' && name[1] == 'l' && name[2] == 'X')) {
314 // XXX: We ignore the majority of the OS-specific calls for now
315 if (name == "glXSwapBuffers" ||
316 name == "wglSwapBuffers") {
317 if (verbosity >= 1) {
323 __drawable->swapBuffers();
326 } else if (name == "glXMakeCurrent" ||
327 name == "wglMakeCurrent") {
329 if (!double_buffer) {
337 if (name == "glFlush") {
339 if (!double_buffer) {
349 // Reached the end of trace
352 long long endTime = OS::GetTime();
353 float timeInterval = (endTime - __startTime) * 1.0E-6;
355 if (verbosity >= -1) {
357 "Rendered " << __frame << " frames"
358 " in " << timeInterval << " secs,"
359 " average of " << (__frame/timeInterval) << " fps\n";
363 while (__ws->processEvents()) {}
369 static void usage(void) {
371 "Usage: glretrace [OPTION] TRACE\n"
374 " -b benchmark (no glgeterror; no messages)\n"
375 " -c PREFIX compare against snapshots\n"
376 " -db use a double buffer visual\n"
377 " -s PREFIX take snapshots\n"
378 " -v verbose output\n"
379 " -D CALLNO dump state at specific call no\n"
380 " -w wait on final frame\n";
383 int main(int argc, char **argv)
387 for (i = 1; i < argc; ++i) {
388 const char *arg = argv[i];
394 if (!strcmp(arg, "--")) {
396 } else if (!strcmp(arg, "-b")) {
399 } else if (!strcmp(arg, "-c")) {
400 __compare_prefix = argv[++i];
401 } else if (!strcmp(arg, "-D")) {
402 __dump_state = atoi(argv[++i]);
404 } else if (!strcmp(arg, "-db")) {
405 double_buffer = true;
406 } else if (!strcmp(arg, "--help")) {
409 } else if (!strcmp(arg, "-s")) {
410 __snapshot_prefix = argv[++i];
411 } else if (!strcmp(arg, "-v")) {
413 } else if (!strcmp(arg, "-w")) {
416 std::cerr << "error: unknown option " << arg << "\n";
422 __ws = glws::createNativeWindowSystem();
423 __visual = __ws->createVisual(double_buffer);
424 __drawable = __ws->createDrawable(__visual);
425 __drawable->resize(__window_width, __window_height);
426 __context = __ws->createContext(__visual);
427 __ws->makeCurrent(__drawable, __context);
429 for ( ; i < argc; ++i) {
430 if (parser.open(argv[i])) {
431 __startTime = OS::GetTime();