git.notmuchmail.org Git - apitrace/blob - glretrace.py

   1 ##########################################################################
   2 #
   3 # Copyright 2010 VMware, Inc.
   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 """GL retracer generator."""
  28
  29
  30 import stdapi
  31 import glapi
  32 from retrace import Retracer
  33
  34
  35 class GlRetracer(Retracer):
  36
  37     def retrace_function(self, function):
  38         Retracer.retrace_function(self, function)
  39
  40     array_pointer_function_names = set((
  41         "glVertexPointer",
  42         "glNormalPointer",
  43         "glColorPointer",
  44         "glIndexPointer",
  45         "glTexCoordPointer",
  46         "glEdgeFlagPointer",
  47         "glFogCoordPointer",
  48         "glSecondaryColorPointer",
  49
  50         "glInterleavedArrays",
  51
  52         #"glVertexPointerEXT",
  53         #"glNormalPointerEXT",
  54         #"glColorPointerEXT",
  55         #"glIndexPointerEXT",
  56         #"glTexCoordPointerEXT",
  57         #"glEdgeFlagPointerEXT",
  58         #"glFogCoordPointerEXT",
  59         #"glSecondaryColorPointerEXT",
  60
  61         #"glVertexAttribPointer",
  62         #"glVertexAttribPointerARB",
  63         #"glVertexAttribPointerNV",
  64         #"glVertexAttribLPointer",
  65
  66         #"glMatrixIndexPointerARB",
  67     ))
  68
  69     draw_array_function_names = set([
  70         "glDrawArrays",
  71         "glDrawArraysEXT",
  72         "glDrawArraysIndirect",
  73         "glDrawArraysInstanced",
  74         "glDrawArraysInstancedARB",
  75         "glDrawArraysInstancedEXT",
  76         "glDrawMeshArraysSUN",
  77         "glMultiDrawArrays",
  78         "glMultiDrawArraysEXT",
  79         "glMultiModeDrawArraysIBM",
  80     ])
  81
  82     draw_elements_function_names = set([
  83         "glDrawElements",
  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",
  97     ])
  98
  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
 103
 104         if is_array_pointer or is_draw_array or is_draw_elements:
 105             print '    if (Trace::Parser::version < 1) {'
 106
 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)
 112                 print '        }'
 113
 114             if is_draw_elements:
 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)
 119                 print '        }'
 120
 121             print '    }'
 122
 123         Retracer.retrace_function_body(self, function)
 124
 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;'
 130             print '    }'
 131             print '    if (y + height > __window_height) {'
 132             print '        __window_height = y + height;'
 133             print '        __reshape_window = true;'
 134             print '    }'
 135
 136         if function.name == "glEnd":
 137             print '    insideGlBeginEnd = false;'
 138
 139         Retracer.call_function(self, function)
 140
 141         if function.name == "glBegin":
 142             print '    insideGlBeginEnd = true;'
 143         else:
 144             # glGetError is not allowed inside glBegin/glEnd
 145             print '    checkGlError();'
 146
 147     pointer_function_names = set([
 148         "glColorPointer",
 149         #"glColorPointerEXT",
 150         "glEdgeFlagPointer",
 151         #"glEdgeFlagPointerEXT",
 152         "glFogCoordPointer",
 153         #"glFogCoordPointerEXT",
 154         "glIndexPointer",
 155         #"glIndexPointerEXT",
 156         #"glMatrixIndexPointerARB",
 157         "glNormalPointer",
 158         #"glNormalPointerEXT",
 159         "glSecondaryColorPointer",
 160         #"glSecondaryColorPointerEXT",
 161         "glTexCoordPointer",
 162         #"glTexCoordPointerEXT",
 163         #"glVertexAttribLPointer",
 164         #"glVertexAttribPointer",
 165         #"glVertexAttribPointerARB",
 166         #"glVertexAttribPointerNV",
 167         "glVertexPointer",
 168         #"glVertexPointerEXT",
 169     ])
 170
 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)
 174             return
 175
 176         if function.name in self.draw_elements_function_names and arg.name == 'indices':
 177             print '    %s = %s.blob();' % (lvalue, rvalue)
 178             return
 179
 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);'
 183
 184         Retracer.extract_arg(self, function, arg, arg_type, lvalue, rvalue)
 185
 186
 187 if __name__ == '__main__':
 188     print r'''
 189 #include <string.h>
 190 #include <stdio.h>
 191 #include <iostream>
 192
 193 #define RETRACE
 194
 195 #include "glproc.hpp"
 196 #include <GL/glut.h>
 197
 198 static bool double_buffer = false;
 199 static bool insideGlBeginEnd = false;
 200
 201 static int __window_width = 256, __window_height = 256;
 202 bool __reshape_window = false;
 203
 204 unsigned __frame = 0;
 205 long long __startTime = 0;
 206 bool __wait = false;
 207
 208 bool __benchmark = false;
 209 const char *__compare_prefix = NULL;
 210 const char *__snapshot_prefix = NULL;
 211
 212
 213 static void
 214 checkGlError(void) {
 215     if (__benchmark || insideGlBeginEnd) {
 216         return;
 217     }
 218
 219     GLenum error = glGetError();
 220     if (error == GL_NO_ERROR) {
 221         return;
 222     }
 223
 224     std::cerr << "warning: glGetError() = ";
 225     switch (error) {
 226     case GL_INVALID_ENUM:
 227         std::cerr << "GL_INVALID_ENUM";
 228         break;
 229     case GL_INVALID_VALUE:
 230         std::cerr << "GL_INVALID_VALUE";
 231         break;
 232     case GL_INVALID_OPERATION:
 233         std::cerr << "GL_INVALID_OPERATION";
 234         break;
 235     case GL_STACK_OVERFLOW:
 236         std::cerr << "GL_STACK_OVERFLOW";
 237         break;
 238     case GL_STACK_UNDERFLOW:
 239         std::cerr << "GL_STACK_UNDERFLOW";
 240         break;
 241     case GL_OUT_OF_MEMORY:
 242         std::cerr << "GL_OUT_OF_MEMORY";
 243         break;
 244     case GL_INVALID_FRAMEBUFFER_OPERATION:
 245         std::cerr << "GL_INVALID_FRAMEBUFFER_OPERATION";
 246         break;
 247     case GL_TABLE_TOO_LARGE:
 248         std::cerr << "GL_TABLE_TOO_LARGE";
 249         break;
 250     default:
 251         std::cerr << error;
 252         break;
 253     }
 254     std::cerr << "\n";
 255 }
 256 '''
 257     api = glapi.glapi
 258     retracer = GlRetracer()
 259     retracer.retrace_api(glapi.glapi)
 260     print r'''
 261
 262 static Trace::Parser parser;
 263
 264 static void display_noop(void) {
 265 }
 266
 267 #include "image.hpp"
 268
 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);
 276     checkGlError();
 277     glReadBuffer(readbuffer);
 278 }
 279
 280 static void frame_complete(void) {
 281     ++__frame;
 282
 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);
 289             if (!ref) {
 290                 return;
 291             }
 292             if (verbosity >= 0)
 293                 std::cout << "Read " << filename << "\n";
 294         }
 295
 296         Image::Image src(__window_width, __window_height, true);
 297         snapshot(src);
 298
 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";
 304             }
 305         }
 306
 307         if (ref) {
 308             std::cout << "Frame " << __frame << " average precision of " << src.compare(*ref) << " bits\n";
 309             delete ref;
 310         }
 311     }
 312
 313 }
 314
 315 static void display(void) {
 316     Trace::Call *call;
 317
 318     while ((call = parser.parse_call())) {
 319         const std::string &name = call->name();
 320
 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                 frame_complete();
 327                 if (double_buffer)
 328                     glutSwapBuffers();
 329                 else
 330                     glFlush();
 331                 return;
 332             } else {
 333                 continue;
 334             }
 335         }
 336
 337         if (name == "glFlush") {
 338             if (!double_buffer) {
 339                 frame_complete();
 340             }
 341             glFlush();
 342         }
 343
 344         retrace_call(*call);
 345
 346         delete call;
 347     }
 348
 349     // Reached the end of trace
 350     glFlush();
 351
 352     long long endTime = OS::GetTime();
 353     float timeInterval = (endTime - __startTime) * 1.0E-6;
 354
 355     std::cout <<
 356         "Rendered " << __frame << " frames"
 357         " in " <<  timeInterval << " secs,"
 358         " average of " << (__frame/timeInterval) << " fps\n";
 359
 360     if (__wait) {
 361         glutDisplayFunc(&display_noop);
 362         glutIdleFunc(NULL);
 363     } else {
 364         exit(0);
 365     }
 366 }
 367
 368 static void idle(void) {
 369     if (__reshape_window) {
 370         // XXX: doesn't quite work
 371         glutReshapeWindow(__window_width, __window_height);
 372         __reshape_window = false;
 373     }
 374     glutPostRedisplay();
 375 }
 376
 377 static void usage(void) {
 378     std::cout <<
 379         "Usage: glretrace [OPTION] TRACE\n"
 380         "Replay TRACE.\n"
 381         "\n"
 382         "  -b           benchmark (no glgeterror; no messages)\n"
 383         "  -c PREFIX    compare against snapshots\n"
 384         "  -db          use a double buffer visual\n"
 385         "  -s PREFIX    take snapshots\n"
 386         "  -v           verbose output\n"
 387         "  -w           wait on final frame\n";
 388 }
 389
 390 int main(int argc, char **argv)
 391 {
 392
 393     int i;
 394     for (i = 1; i < argc; ++i) {
 395         const char *arg = argv[i];
 396
 397         if (arg[0] != '-') {
 398             break;
 399         }
 400
 401         if (!strcmp(arg, "--")) {
 402             break;
 403         } else if (!strcmp(arg, "-b")) {
 404             __benchmark = true;
 405             --verbosity;
 406         } else if (!strcmp(arg, "-c")) {
 407             __compare_prefix = argv[++i];
 408         } else if (!strcmp(arg, "-db")) {
 409             double_buffer = true;
 410         } else if (!strcmp(arg, "--help")) {
 411             usage();
 412             return 0;
 413         } else if (!strcmp(arg, "-s")) {
 414             __snapshot_prefix = argv[++i];
 415         } else if (!strcmp(arg, "-v")) {
 416             ++verbosity;
 417         } else if (!strcmp(arg, "-w")) {
 418             __wait = true;
 419         } else {
 420             std::cerr << "error: unknown option " << arg << "\n";
 421             usage();
 422             return 1;
 423         }
 424     }
 425
 426     glutInit(&argc, argv);
 427     glutInitWindowPosition(0, 0);
 428     glutInitWindowSize(__window_width, __window_height);
 429     glutInitDisplayMode(GLUT_DEPTH | GLUT_RGB | (double_buffer ? GLUT_DOUBLE : GLUT_SINGLE));
 430     glutCreateWindow(argv[0]);
 431
 432     glutDisplayFunc(&display);
 433     glutIdleFunc(&idle);
 434
 435     for (GLuint h = 0; h < 1024; ++h) {
 436         __list_map[h] = h;
 437     }
 438
 439     for ( ; i < argc; ++i) {
 440         if (parser.open(argv[i])) {
 441             __startTime = OS::GetTime();
 442             glutMainLoop();
 443             parser.close();
 444         }
 445     }
 446
 447     return 0;
 448 }
 449
 450 '''