#include <string.h>
+#include "os_path.hpp"
#include "image.hpp"
#include "retrace.hpp"
#include "glproc.hpp"
+#include "glstate.hpp"
#include "glretrace.hpp"
namespace glretrace {
-bool double_buffer = false;
+bool double_buffer = true;
bool insideGlBeginEnd = false;
-Trace::Parser parser;
-glws::WindowSystem *ws = NULL;
+trace::Parser parser;
glws::Visual *visual = NULL;
glws::Drawable *drawable = NULL;
glws::Context *context = NULL;
bool benchmark = false;
const char *compare_prefix = NULL;
const char *snapshot_prefix = NULL;
+enum frequency snapshot_frequency = FREQUENCY_NEVER;
unsigned dump_state = ~0;
void
-checkGlError(Trace::Call &call) {
- if (benchmark || insideGlBeginEnd) {
- return;
- }
-
+checkGlError(trace::Call &call) {
GLenum error = glGetError();
if (error == GL_NO_ERROR) {
return;
}
- if (retrace::verbosity == 0) {
- std::cout << call;
- std::cout.flush();
- }
+ std::ostream & os = retrace::warning(call);
- std::cerr << call.no << ": ";
- std::cerr << "warning: glGetError(";
- std::cerr << call.name();
- std::cerr << ") = ";
+ os << "glGetError(";
+ os << call.name();
+ os << ") = ";
switch (error) {
case GL_INVALID_ENUM:
- std::cerr << "GL_INVALID_ENUM";
+ os << "GL_INVALID_ENUM";
break;
case GL_INVALID_VALUE:
- std::cerr << "GL_INVALID_VALUE";
+ os << "GL_INVALID_VALUE";
break;
case GL_INVALID_OPERATION:
- std::cerr << "GL_INVALID_OPERATION";
+ os << "GL_INVALID_OPERATION";
break;
case GL_STACK_OVERFLOW:
- std::cerr << "GL_STACK_OVERFLOW";
+ os << "GL_STACK_OVERFLOW";
break;
case GL_STACK_UNDERFLOW:
- std::cerr << "GL_STACK_UNDERFLOW";
+ os << "GL_STACK_UNDERFLOW";
break;
case GL_OUT_OF_MEMORY:
- std::cerr << "GL_OUT_OF_MEMORY";
+ os << "GL_OUT_OF_MEMORY";
break;
case GL_INVALID_FRAMEBUFFER_OPERATION:
- std::cerr << "GL_INVALID_FRAMEBUFFER_OPERATION";
+ os << "GL_INVALID_FRAMEBUFFER_OPERATION";
break;
case GL_TABLE_TOO_LARGE:
- std::cerr << "GL_TABLE_TOO_LARGE";
+ os << "GL_TABLE_TOO_LARGE";
break;
default:
- std::cerr << error;
+ os << error;
break;
}
- std::cerr << "\n";
+ os << "\n";
}
+/**
+ * Grow the current drawble.
+ *
+ * We need to infer the drawable size from GL calls because the drawable sizes
+ * are specified by OS specific calls which we do not trace.
+ */
+void
+updateDrawable(int width, int height) {
+ if (!drawable) {
+ return;
+ }
+
+ if (drawable->visible &&
+ width <= drawable->width &&
+ height <= drawable->height) {
+ return;
+ }
+
+ // Check for bound framebuffer last, as this may have a performance impact.
+ GLint draw_framebuffer = 0;
+ glGetIntegerv(GL_DRAW_FRAMEBUFFER_BINDING, &draw_framebuffer);
+ if (draw_framebuffer != 0) {
+ return;
+ }
+
+ drawable->resize(width, height);
+ drawable->show();
-static void snapshot(Image::Image &image) {
- GLint drawbuffer = double_buffer ? GL_BACK : GL_FRONT;
- GLint readbuffer = double_buffer ? GL_BACK : GL_FRONT;
- glGetIntegerv(GL_DRAW_BUFFER, &drawbuffer);
- glGetIntegerv(GL_READ_BUFFER, &readbuffer);
- glReadBuffer(drawbuffer);
- glReadPixels(0, 0, image.width, image.height, GL_RGBA, GL_UNSIGNED_BYTE, image.pixels);
- glReadBuffer(readbuffer);
+ glScissor(0, 0, width, height);
}
-void frame_complete(unsigned call_no) {
- ++frame;
-
- if (drawable &&
- (snapshot_prefix || compare_prefix)) {
- Image::Image *ref = NULL;
- if (compare_prefix) {
- char filename[PATH_MAX];
- snprintf(filename, sizeof filename, "%s%010u.png", compare_prefix, call_no);
- ref = Image::readPNG(filename);
- if (!ref) {
- return;
- }
- if (retrace::verbosity >= 0)
- std::cout << "Read " << filename << "\n";
+void snapshot(unsigned call_no) {
+ if (!drawable ||
+ (!snapshot_prefix && !compare_prefix)) {
+ return;
+ }
+
+ image::Image *ref = NULL;
+
+ if (compare_prefix) {
+ os::Path filename = os::Path::format("%s%010u.png", compare_prefix, call_no);
+ ref = image::readPNG(filename);
+ if (!ref) {
+ return;
}
-
- Image::Image src(drawable->width, drawable->height, true);
- snapshot(src);
-
- if (snapshot_prefix) {
- char filename[PATH_MAX];
- snprintf(filename, sizeof filename, "%s%010u.png", snapshot_prefix, call_no);
- if (src.writePNG(filename) && retrace::verbosity >= 0) {
+ if (retrace::verbosity >= 0) {
+ std::cout << "Read " << filename << "\n";
+ }
+ }
+
+ image::Image *src = glstate::getDrawBufferImage(GL_RGBA);
+ if (!src) {
+ return;
+ }
+
+ if (snapshot_prefix) {
+ if (snapshot_prefix[0] == '-' && snapshot_prefix[1] == 0) {
+ char comment[21];
+ snprintf(comment, sizeof comment, "%u", call_no);
+ src->writePNM(std::cout, comment);
+ } else {
+ os::Path filename = os::Path::format("%s%010u.png", snapshot_prefix, call_no);
+ if (src->writePNG(filename) && retrace::verbosity >= 0) {
std::cout << "Wrote " << filename << "\n";
}
}
+ }
- if (ref) {
- std::cout << "Snapshot " << call_no << " average precision of " << src.compare(*ref) << " bits\n";
- delete ref;
- }
+ if (ref) {
+ std::cout << "Snapshot " << call_no << " average precision of " << src->compare(*ref) << " bits\n";
+ delete ref;
+ }
+
+ delete src;
+}
+
+
+void frame_complete(trace::Call &call) {
+ ++frame;
+
+ if (!drawable) {
+ return;
}
+ if (!drawable->visible) {
+ retrace::warning(call) << "could not infer drawable size (glViewport never called)\n";
+ }
+
+ if (snapshot_frequency == FREQUENCY_FRAME ||
+ snapshot_frequency == FREQUENCY_FRAMEBUFFER) {
+ snapshot(call.no);
+ }
}
static void display(void) {
- Trace::Call *call;
+ retrace::Retracer retracer;
- while ((call = parser.parse_call())) {
- const std::string &name = call->name();
+ retracer.addCallbacks(gl_callbacks);
+ retracer.addCallbacks(glx_callbacks);
+ retracer.addCallbacks(wgl_callbacks);
+ retracer.addCallbacks(cgl_callbacks);
+ retracer.addCallbacks(egl_callbacks);
- if (retrace::verbosity >= 1) {
- std::cout << *call;
- std::cout.flush();
- }
+ startTime = os::getTime();
+ trace::Call *call;
- if (name[0] == 'w' && name[1] == 'g' && name[2] == 'l') {
- glretrace::retrace_call_wgl(*call);
- }
- else if (name[0] == 'g' && name[1] == 'l' && name[2] == 'X') {
- glretrace::retrace_call_glx(*call);
- } else {
- retrace::retrace_call(*call);
- }
+ while ((call = parser.parse_call())) {
+ retracer.retrace(*call);
if (!insideGlBeginEnd &&
drawable && context &&
call->no >= dump_state) {
- state_dump(std::cout);
+ glstate::dumpCurrentContext(std::cout);
exit(0);
}
// Reached the end of trace
glFlush();
- long long endTime = OS::GetTime();
+ long long endTime = os::getTime();
float timeInterval = (endTime - startTime) * 1.0E-6;
if (retrace::verbosity >= -1) {
}
if (wait) {
- while (ws->processEvents()) {}
+ while (glws::processEvents()) {}
} else {
exit(0);
}
"Usage: glretrace [OPTION] TRACE\n"
"Replay TRACE.\n"
"\n"
- " -b benchmark (no glgeterror; no messages)\n"
+ " -b benchmark mode (no error checking or warning messages)\n"
" -c PREFIX compare against snapshots\n"
- " -db use a double buffer visual\n"
- " -s PREFIX take snapshots\n"
+ " -db use a double buffer visual (default)\n"
+ " -sb use a single buffer visual\n"
+ " -s PREFIX take snapshots; `-` for PNM stdout output\n"
+ " -S FREQUENCY snapshot frequency: frame (default), framebuffer, or draw\n"
" -v verbose output\n"
" -D CALLNO dump state at specific call no\n"
" -w wait on final frame\n";
} else if (!strcmp(arg, "-b")) {
benchmark = true;
retrace::verbosity = -1;
+ glws::debug = false;
} else if (!strcmp(arg, "-c")) {
compare_prefix = argv[++i];
+ if (snapshot_frequency == FREQUENCY_NEVER) {
+ snapshot_frequency = FREQUENCY_FRAME;
+ }
} else if (!strcmp(arg, "-D")) {
dump_state = atoi(argv[++i]);
retrace::verbosity = -2;
} else if (!strcmp(arg, "-db")) {
double_buffer = true;
+ } else if (!strcmp(arg, "-sb")) {
+ double_buffer = false;
} else if (!strcmp(arg, "--help")) {
usage();
return 0;
} else if (!strcmp(arg, "-s")) {
snapshot_prefix = argv[++i];
+ if (snapshot_frequency == FREQUENCY_NEVER) {
+ snapshot_frequency = FREQUENCY_FRAME;
+ }
+ if (snapshot_prefix[0] == '-' && snapshot_prefix[1] == 0) {
+ retrace::verbosity = -2;
+ }
+ } else if (!strcmp(arg, "-S")) {
+ arg = argv[++i];
+ if (!strcmp(arg, "frame")) {
+ snapshot_frequency = FREQUENCY_FRAME;
+ } else if (!strcmp(arg, "framebuffer")) {
+ snapshot_frequency = FREQUENCY_FRAMEBUFFER;
+ } else if (!strcmp(arg, "draw")) {
+ snapshot_frequency = FREQUENCY_DRAW;
+ } else {
+ std::cerr << "error: unknown frequency " << arg << "\n";
+ usage();
+ return 1;
+ }
+ if (snapshot_prefix == NULL) {
+ snapshot_prefix = "";
+ }
} else if (!strcmp(arg, "-v")) {
++retrace::verbosity;
} else if (!strcmp(arg, "-w")) {
}
}
- ws = glws::createNativeWindowSystem();
- visual = ws->createVisual(double_buffer);
+ glws::init();
+ visual = glws::createVisual(double_buffer);
for ( ; i < argc; ++i) {
- if (parser.open(argv[i])) {
- startTime = OS::GetTime();
- display();
- parser.close();
+ if (!parser.open(argv[i])) {
+ std::cerr << "error: failed to open " << argv[i] << "\n";
+ return 1;
}
+
+ display();
+
+ parser.close();
}
+
+ delete visual;
+ glws::cleanup();
return 0;
}