]> git.cworth.org Git - apitrace/blobdiff - glretrace.py
Abstract retracing into a class of its own.
[apitrace] / glretrace.py
index 606c052e33f3a0c15fd4aa81d0a48ee9509f2f3a..fd1460a550444ec0048b1990fd06165cfa205c71 100644 (file)
 ##########################################################################/
 
 
+"""GL retracer generator."""
+
+
 import stdapi
 import glapi
-import retrace
+from retrace import Retracer
+
+
+class GlRetracer(Retracer):
+
+    def retrace_function(self, function):
+        Retracer.retrace_function(self, function)
+
+    array_pointer_function_names = set((
+        "glVertexPointer",
+        "glNormalPointer",
+        "glColorPointer",
+        "glIndexPointer",
+        "glTexCoordPointer",
+        "glEdgeFlagPointer",
+        "glFogCoordPointer",
+        "glSecondaryColorPointer",
+
+        "glInterleavedArrays",
+
+        #"glVertexPointerEXT",
+        #"glNormalPointerEXT",
+        #"glColorPointerEXT",
+        #"glIndexPointerEXT",
+        #"glTexCoordPointerEXT",
+        #"glEdgeFlagPointerEXT",
+        #"glFogCoordPointerEXT",
+        #"glSecondaryColorPointerEXT",
+
+        "glVertexAttribPointer",
+        "glVertexAttribPointerARB",
+        "glVertexAttribPointerNV",
+        "glVertexAttribLPointer",
+        "glVertexAttribLPointerEXT",
+        
+        #"glMatrixIndexPointerARB",
+    ))
+
+    draw_array_function_names = set([
+        "glDrawArrays",
+        "glDrawArraysEXT",
+        "glDrawArraysIndirect",
+        "glDrawArraysInstanced",
+        "glDrawArraysInstancedARB",
+        "glDrawArraysInstancedEXT",
+        "glDrawMeshArraysSUN",
+        "glMultiDrawArrays",
+        "glMultiDrawArraysEXT",
+        "glMultiModeDrawArraysIBM",
+    ])
+
+    draw_elements_function_names = set([
+        "glDrawElements",
+        "glDrawElementsBaseVertex",
+        "glDrawElementsIndirect",
+        "glDrawElementsInstanced",
+        "glDrawElementsInstancedARB",
+        "glDrawElementsInstancedBaseVertex",
+        "glDrawElementsInstancedEXT",
+        "glDrawRangeElements",
+        "glDrawRangeElementsBaseVertex",
+        "glDrawRangeElementsEXT",
+        #"glMultiDrawElements",
+        #"glMultiDrawElementsBaseVertex",
+        #"glMultiDrawElementsEXT",
+        #"glMultiModeDrawElementsIBM",
+    ])
+
+    def retrace_function_body(self, function):
+        is_array_pointer = function.name in self.array_pointer_function_names
+        is_draw_array = function.name in self.draw_array_function_names
+        is_draw_elements = function.name in self.draw_elements_function_names
+
+        if is_array_pointer or is_draw_array or is_draw_elements:
+            print '    if (Trace::Parser::version < 1) {'
+
+            if is_array_pointer or is_draw_array:
+                print '        GLint __array_buffer = 0;'
+                print '        glGetIntegerv(GL_ARRAY_BUFFER_BINDING, &__array_buffer);'
+                print '        if (!__array_buffer) {'
+                self.fail_function(function)
+                print '        }'
+
+            if is_draw_elements:
+                print '        GLint __element_array_buffer = 0;'
+                print '        glGetIntegerv(GL_ELEMENT_ARRAY_BUFFER_BINDING, &__element_array_buffer);'
+                print '        if (!__element_array_buffer) {'
+                self.fail_function(function)
+                print '        }'
+            
+            print '    }'
+
+        Retracer.retrace_function_body(self, function)
 
+    def call_function(self, function):
+        if function.name == "glViewport":
+            print '    if (x + width > __window_width) {'
+            print '        __window_width = x + width;'
+            print '        __reshape_window = true;'
+            print '    }'
+            print '    if (y + height > __window_height) {'
+            print '        __window_height = y + height;'
+            print '        __reshape_window = true;'
+            print '    }'
 
-class GlRetracer(retrace.Retracer):
+        if function.name == "glEnd":
+            print '    insideGlBeginEnd = false;'
+        
+        Retracer.call_function(self, function)
 
-    pass
+        if function.name == "glBegin":
+            print '    insideGlBeginEnd = true;'
+        else:
+            # glGetError is not allowed inside glBegin/glEnd
+            print '    checkGlError();'
+
+    def extract_arg(self, function, arg, arg_type, lvalue, rvalue):
+        if function.name in self.array_pointer_function_names and arg.name == 'pointer':
+            print '    %s = %s.blob();' % (lvalue, rvalue)
+            return
+
+        if function.name in self.draw_elements_function_names and arg.name == 'indices':
+            print '    %s = %s.blob();' % (lvalue, rvalue)
+            return
+
+        if function.name.startswith('glUniform') and function.args[0].name == arg.name == 'location':
+            print '    GLint program = -1;'
+            print '    glGetIntegerv(GL_CURRENT_PROGRAM, &program);'
+
+        Retracer.extract_arg(self, function, arg, arg_type, lvalue, rvalue)
 
 
 if __name__ == '__main__':
-    print
-    print '#include <stdlib.h>'
-    print '#include <string.h>'
-    print
-    print '#ifdef WIN32'
-    print '#include <windows.h>'
-    print '#endif'
-    print
-    print '#include <GL/glew.h>'
-    print '#include <GL/glut.h>'
-    print
+    print r'''
+#include <string.h>
+#include <stdio.h>
+#include <iostream>
+
+#define RETRACE
+
+#include "glproc.hpp"
+#include "glstate.hpp"
+
+#include <GL/glut.h>
+
+static bool double_buffer = false;
+static bool insideGlBeginEnd = false;
+
+static int __window_width = 256, __window_height = 256;
+bool __reshape_window = false;
+
+unsigned __frame = 0;
+long long __startTime = 0;
+bool __wait = false;
+
+bool __benchmark = false;
+const char *__compare_prefix = NULL;
+const char *__snapshot_prefix = NULL;
+
+unsigned __dump_state = ~0;
+
+
+static void
+checkGlError(void) {
+    if (__benchmark || insideGlBeginEnd) {
+        return;
+    }
+
+    GLenum error = glGetError();
+    if (error == GL_NO_ERROR) {
+        return;
+    }
+
+    std::cerr << "warning: glGetError() = ";
+    switch (error) {
+    case GL_INVALID_ENUM:
+        std::cerr << "GL_INVALID_ENUM";
+        break;
+    case GL_INVALID_VALUE:
+        std::cerr << "GL_INVALID_VALUE";
+        break;
+    case GL_INVALID_OPERATION:
+        std::cerr << "GL_INVALID_OPERATION";
+        break;
+    case GL_STACK_OVERFLOW:
+        std::cerr << "GL_STACK_OVERFLOW";
+        break;
+    case GL_STACK_UNDERFLOW:
+        std::cerr << "GL_STACK_UNDERFLOW";
+        break;
+    case GL_OUT_OF_MEMORY:
+        std::cerr << "GL_OUT_OF_MEMORY";
+        break;
+    case GL_INVALID_FRAMEBUFFER_OPERATION:
+        std::cerr << "GL_INVALID_FRAMEBUFFER_OPERATION";
+        break;
+    case GL_TABLE_TOO_LARGE:
+        std::cerr << "GL_TABLE_TOO_LARGE";
+        break;
+    default:
+        std::cerr << error;
+        break;
+    }
+    std::cerr << "\n";
+}
+'''
     api = glapi.glapi
     retracer = GlRetracer()
     retracer.retrace_api(glapi.glapi)
-    print '''
+    print r'''
+
+static Trace::Parser parser;
+
+static void display_noop(void) {
+}
+
+#include "image.hpp"
+
+static void snapshot(Image::Image &image) {
+    GLint drawbuffer = double_buffer ? GL_BACK : GL_FRONT;
+    GLint readbuffer = double_buffer ? GL_BACK : GL_FRONT;
+    glGetIntegerv(GL_READ_BUFFER, &drawbuffer);
+    glGetIntegerv(GL_READ_BUFFER, &readbuffer);
+    glReadBuffer(drawbuffer);
+    glReadPixels(0, 0, image.width, image.height, GL_RGBA, GL_UNSIGNED_BYTE, image.pixels);
+    checkGlError();
+    glReadBuffer(readbuffer);
+}
+
+static void frame_complete(void) {
+    ++__frame;
+    
+    if (!__reshape_window && (__snapshot_prefix || __compare_prefix)) {
+        Image::Image *ref = NULL;
+        if (__compare_prefix) {
+            char filename[PATH_MAX];
+            snprintf(filename, sizeof filename, "%s%04u.png", __compare_prefix, __frame);
+            ref = Image::readPNG(filename);
+            if (!ref) {
+                return;
+            }
+            if (verbosity >= 0)
+                std::cout << "Read " << filename << "\n";
+        }
+        
+        Image::Image src(__window_width, __window_height, true);
+        snapshot(src);
+
+        if (__snapshot_prefix) {
+            char filename[PATH_MAX];
+            snprintf(filename, sizeof filename, "%s%04u.png", __snapshot_prefix, __frame);
+            if (src.writePNG(filename) && verbosity >= 0) {
+                std::cout << "Wrote " << filename << "\n";
+            }
+        }
 
-Trace::Parser parser;
+        if (ref) {
+            std::cout << "Frame " << __frame << " average precision of " << src.compare(*ref) << " bits\n";
+            delete ref;
+        }
+    }
 
-static bool insideGlBeginEnd;
+}
 
 static void display(void) {
-   Trace::Call *call;
-
-   while ((call = parser.parse_call())) {
-      if (call->name == "glFlush" ||
-          call->name == "glXSwapBuffers" ||
-          call->name == "wglSwapBuffers") {
-         glFlush();
-         return;
-      }
-      
-      retrace_call(*call);
-
-      if (call->name == "glBegin") {
-         insideGlBeginEnd = true;
-      }
-      
-      if (call->name == "glEnd") {
-         insideGlBeginEnd = false;
-      }
-
-      if (!insideGlBeginEnd) {
-         GLenum error = glGetError();
-         if (error != GL_NO_ERROR) {
-            std::cerr << "warning: glGetError() = ";
-            switch (error) {
-            case GL_INVALID_ENUM:
-               std::cerr << "GL_INVALID_ENUM";
-               break;
-            case GL_INVALID_VALUE:
-               std::cerr << "GL_INVALID_VALUE";
-               break;
-            case GL_INVALID_OPERATION:
-               std::cerr << "GL_INVALID_OPERATION";
-               break;
-            case GL_STACK_OVERFLOW:
-               std::cerr << "GL_STACK_OVERFLOW";
-               break;
-            case GL_STACK_UNDERFLOW:
-               std::cerr << "GL_STACK_UNDERFLOW";
-               break;
-            case GL_OUT_OF_MEMORY:
-               std::cerr << "GL_OUT_OF_MEMORY";
-               break;
-            case GL_INVALID_FRAMEBUFFER_OPERATION:
-               std::cerr << "GL_INVALID_FRAMEBUFFER_OPERATION";
-               break;
-            case GL_TABLE_TOO_LARGE:
-               std::cerr << "GL_TABLE_TOO_LARGE";
-               break;
-            default:
-               std::cerr << error;
-               break;
+    Trace::Call *call;
+
+    while ((call = parser.parse_call())) {
+        const std::string &name = call->name();
+
+        if (call->no == __dump_state) {
+            state_dump(std::cout);
+            exit(0);
+        }
+
+        if ((name[0] == 'w' && name[1] == 'g' && name[2] == 'l') ||
+            (name[0] == 'g' && name[1] == 'l' && name[2] == 'X')) {
+            // XXX: We ignore the majority of the OS-specific calls for now
+            if (name == "glXSwapBuffers" ||
+                name == "wglSwapBuffers") {
+                if (verbosity >= 1) {
+                    std::cout << *call;
+                    std::cout.flush();
+                };
+                frame_complete();
+                if (double_buffer)
+                    glutSwapBuffers();
+                else
+                    glFlush();
+
+                // Return now to allow GLUT to resize the window.
+                delete call;
+                return;
+            } else if (name == "glXMakeCurrent" ||
+                       name == "wglMakeCurrent") {
+                glFlush();
+                if (!double_buffer) {
+                    frame_complete();
+                    // Return now to allow GLUT to resize window.
+                    delete call;
+                    return;
+                }
+            } else {
+                continue;
             }
-            std::cerr << "\\n";
-         }
-      }
-   }
+        }
 
-   glFlush();
-   glutIdleFunc(NULL);
+        if (name == "glFlush") {
+            glFlush();
+            if (!double_buffer) {
+                frame_complete();
+            }
+        }
+        
+        retrace_call(*call);
+
+        delete call;
+    }
+
+    // Reached the end of trace
+    glFlush();
+
+    long long endTime = OS::GetTime();
+    float timeInterval = (endTime - __startTime) * 1.0E-6;
+
+    if (verbosity >= -1) { 
+        std::cout << 
+            "Rendered " << __frame << " frames"
+            " in " <<  timeInterval << " secs,"
+            " average of " << (__frame/timeInterval) << " fps\n";
+    }
+
+    if (__wait) {
+        glutDisplayFunc(&display_noop);
+        glutIdleFunc(NULL);
+    } else {
+        exit(0);
+    }
 }
 
 static void idle(void) {
-   glutPostRedisplay();
+    if (__reshape_window) {
+        // XXX: doesn't quite work
+        glutReshapeWindow(__window_width, __window_height);
+        __reshape_window = false;
+    }
+    glutPostRedisplay();
+}
+
+static void usage(void) {
+    std::cout << 
+        "Usage: glretrace [OPTION] TRACE\n"
+        "Replay TRACE.\n"
+        "\n"
+        "  -b           benchmark (no glgeterror; no messages)\n"
+        "  -c PREFIX    compare against snapshots\n"
+        "  -db          use a double buffer visual\n"
+        "  -s PREFIX    take snapshots\n"
+        "  -v           verbose output\n"
+        "  -D CALLNO    dump state at specific call no\n"
+        "  -w           wait on final frame\n";
 }
 
 int main(int argc, char **argv)
 {
-   glutInit(&argc, argv);
-   glutInitWindowPosition(0, 0);
-   glutInitWindowSize(800, 600);
-   glutInitDisplayMode(GLUT_DEPTH | GLUT_RGB | GLUT_SINGLE);
-   glutCreateWindow(argv[0]);
-   glewInit();
-
-   glutDisplayFunc(&display);
-   glutIdleFunc(&idle);
 
     int i;
     for (i = 1; i < argc; ++i) {
-      const char *arg = argv[i];
-
-      if (arg[0] != '-') {
-         break;
-      }
-
-      if (!strcmp(arg, "--")) {
-         break;
-      }
-      else if (!strcmp(arg, "-v")) {
-         ++verbosity;
-      } else {
-         std::cerr << "error: unknown option " << arg << "\\n";
-         return 1;
-      }
-   }
-
-   for ( ; i < argc; ++i) {
-      if (parser.open(argv[i])) {
-         glutMainLoop();
-         parser.close();
-      }
-   }
-
-   return 0;
+        const char *arg = argv[i];
+
+        if (arg[0] != '-') {
+            break;
+        }
+
+        if (!strcmp(arg, "--")) {
+            break;
+        } else if (!strcmp(arg, "-b")) {
+            __benchmark = true;
+            verbosity = -1;
+        } else if (!strcmp(arg, "-c")) {
+            __compare_prefix = argv[++i];
+        } else if (!strcmp(arg, "-D")) {
+            __dump_state = atoi(argv[++i]);
+            verbosity = -2;
+        } else if (!strcmp(arg, "-db")) {
+            double_buffer = true;
+        } else if (!strcmp(arg, "--help")) {
+            usage();
+            return 0;
+        } else if (!strcmp(arg, "-s")) {
+            __snapshot_prefix = argv[++i];
+        } else if (!strcmp(arg, "-v")) {
+            ++verbosity;
+        } else if (!strcmp(arg, "-w")) {
+            __wait = true;
+        } else {
+            std::cerr << "error: unknown option " << arg << "\n";
+            usage();
+            return 1;
+        }
+    }
+
+    glutInit(&argc, argv);
+    glutInitWindowPosition(0, 0);
+    glutInitWindowSize(__window_width, __window_height);
+    glutInitDisplayMode(GLUT_DEPTH | GLUT_RGB | (double_buffer ? GLUT_DOUBLE : GLUT_SINGLE));
+    glutCreateWindow(argv[0]);
+
+    glutDisplayFunc(&display);
+    glutIdleFunc(&idle);
+
+    for (GLuint h = 0; h < 1024; ++h) {
+        __list_map[h] = h;
+    }
+
+    for ( ; i < argc; ++i) {
+        if (parser.open(argv[i])) {
+            __startTime = OS::GetTime();
+            glutMainLoop();
+            parser.close();
+        }
+    }
+
+    return 0;
 }
 
-'''   
+'''