]> git.cworth.org Git - apitrace/blobdiff - glretrace.py
Abstract retracing into a class of its own.
[apitrace] / glretrace.py
index 39a818a47f8a78582815772e7ec88609e4b0834c..fd1460a550444ec0048b1990fd06165cfa205c71 100644 (file)
@@ -24,6 +24,9 @@
 ##########################################################################/
 
 
+"""GL retracer generator."""
+
+
 import stdapi
 import glapi
 from retrace import Retracer
@@ -31,75 +34,166 @@ from retrace import Retracer
 
 class GlRetracer(Retracer):
 
-    def filter_function(self, function):
-        return function.name not in [
-            "glNewBufferRegion",
-            "glDeleteBufferRegion",
-            "glReadBufferRegion",
-            "glDrawBufferRegion",
-            "glBufferRegionEnabled",
-        ]
-
     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 in ("glDrawArrays", "glDrawElements", "glDrawRangeElements", "glMultiDrawElements"):
-            print '    GLint __array_buffer = 0;'
-            print '    glGetIntegerv(GL_ARRAY_BUFFER_BINDING, &__array_buffer);'
-            print '    if (!__array_buffer) {'
-            self.fail_function(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 '    }'
 
         if function.name == "glEnd":
             print '    insideGlBeginEnd = false;'
+        
         Retracer.call_function(self, function)
+
         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 [
-            "glColorPointer",
-            "glEdgeFlagPointer",
-            "glIndexPointer",
-            "glNormalPointer",
-            "glTexCoordPointer",
-            "glVertexPointer",
-            "glFogCoordPointer",
-            "glSecondaryColorPointer",
-            "glVertexAttribPointer",
-        ] and arg.name == 'pointer':
-            self.extract_pointer(function, arg, arg_type, lvalue, rvalue)
-        else:
-            Retracer.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);'
 
-    def extract_pointer(self, function, arg, arg_type, lvalue, rvalue):
-        print '    if (dynamic_cast<Trace::Null *>(&%s)) {' % rvalue
-        print '        %s = 0;' % (lvalue)
-        print '    } else {'
-        print '        %s = (%s)(uintptr_t)(%s);' % (lvalue, arg_type, rvalue)
-        print '    }'
+        Retracer.extract_arg(self, function, arg, arg_type, lvalue, rvalue)
 
 
 if __name__ == '__main__':
-    print
-    print '#include <string.h>'
-    print '#include <iostream>'
-    print
-    print '#include "glproc.hpp"'
-    print '#include <GL/glut.h>'
-    print
-    print 'static bool double_buffer = false;'
-    print 'static bool insideGlBeginEnd = false;'
-    print
-    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 (insideGlBeginEnd) {
+    if (__benchmark || insideGlBeginEnd) {
         return;
     }
 
@@ -138,45 +232,166 @@ checkGlError(void) {
         std::cerr << error;
         break;
     }
-    std::cerr << "\\n";
+    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";
+            }
+        }
+
+        if (ref) {
+            std::cout << "Frame " << __frame << " average precision of " << src.compare(*ref) << " bits\n";
+            delete ref;
+        }
+    }
+
+}
+
 static void display(void) {
     Trace::Call *call;
 
     while ((call = parser.parse_call())) {
-        if (call->name() == "glFlush") {
-            glFlush();
-            return;
+        const std::string &name = call->name();
+
+        if (call->no == __dump_state) {
+            state_dump(std::cout);
+            exit(0);
         }
-        
-        if (!retrace_call(*call)) {
-            if (call->name() == "glXSwapBuffers" ||
-                call->name() == "wglSwapBuffers") {
+
+        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;
             }
         }
+
+        if (name == "glFlush") {
+            glFlush();
+            if (!double_buffer) {
+                frame_complete();
+            }
+        }
+        
+        retrace_call(*call);
+
+        delete call;
     }
 
+    // Reached the end of trace
     glFlush();
-    glutIdleFunc(NULL);
+
+    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) {
+    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)
 {
 
@@ -190,20 +405,35 @@ int main(int argc, char **argv)
 
         if (!strcmp(arg, "--")) {
             break;
-        }
-        else if (!strcmp(arg, "-db")) {
+        } 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";
+            std::cerr << "error: unknown option " << arg << "\n";
+            usage();
             return 1;
         }
     }
 
     glutInit(&argc, argv);
     glutInitWindowPosition(0, 0);
-    glutInitWindowSize(800, 600);
+    glutInitWindowSize(__window_width, __window_height);
     glutInitDisplayMode(GLUT_DEPTH | GLUT_RGB | (double_buffer ? GLUT_DOUBLE : GLUT_SINGLE));
     glutCreateWindow(argv[0]);
 
@@ -216,6 +446,7 @@ int main(int argc, char **argv)
 
     for ( ; i < argc; ++i) {
         if (parser.open(argv[i])) {
+            __startTime = OS::GetTime();
             glutMainLoop();
             parser.close();
         }