1 /**************************************************************************
3 * Copyright 2011 Jose Fonseca
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 **************************************************************************/
30 #include "retrace.hpp"
32 #include "glretrace.hpp"
37 bool double_buffer = false;
38 bool insideGlBeginEnd = false;
40 glws::WindowSystem *ws = NULL;
41 glws::Visual *visual = NULL;
42 glws::Drawable *drawable = NULL;
43 glws::Context *context = NULL;
45 int window_width = 256, window_height = 256;
48 long long startTime = 0;
51 bool benchmark = false;
52 const char *compare_prefix = NULL;
53 const char *snapshot_prefix = NULL;
55 unsigned dump_state = ~0;
58 checkGlError(int callIdx) {
59 if (benchmark || insideGlBeginEnd) {
63 GLenum error = glGetError();
64 if (error == GL_NO_ERROR) {
69 std::cerr << callIdx << ": ";
72 std::cerr << "warning: glGetError() = ";
75 std::cerr << "GL_INVALID_ENUM";
77 case GL_INVALID_VALUE:
78 std::cerr << "GL_INVALID_VALUE";
80 case GL_INVALID_OPERATION:
81 std::cerr << "GL_INVALID_OPERATION";
83 case GL_STACK_OVERFLOW:
84 std::cerr << "GL_STACK_OVERFLOW";
86 case GL_STACK_UNDERFLOW:
87 std::cerr << "GL_STACK_UNDERFLOW";
89 case GL_OUT_OF_MEMORY:
90 std::cerr << "GL_OUT_OF_MEMORY";
92 case GL_INVALID_FRAMEBUFFER_OPERATION:
93 std::cerr << "GL_INVALID_FRAMEBUFFER_OPERATION";
95 case GL_TABLE_TOO_LARGE:
96 std::cerr << "GL_TABLE_TOO_LARGE";
106 static void snapshot(Image::Image &image) {
107 GLint drawbuffer = double_buffer ? GL_BACK : GL_FRONT;
108 GLint readbuffer = double_buffer ? GL_BACK : GL_FRONT;
109 glGetIntegerv(GL_DRAW_BUFFER, &drawbuffer);
110 glGetIntegerv(GL_READ_BUFFER, &readbuffer);
111 glReadBuffer(drawbuffer);
112 glReadPixels(0, 0, image.width, image.height, GL_RGBA, GL_UNSIGNED_BYTE, image.pixels);
114 glReadBuffer(readbuffer);
118 static void frame_complete(unsigned call_no) {
121 if (snapshot_prefix || compare_prefix) {
122 Image::Image *ref = NULL;
123 if (compare_prefix) {
124 char filename[PATH_MAX];
125 snprintf(filename, sizeof filename, "%s%010u.png", compare_prefix, call_no);
126 ref = Image::readPNG(filename);
130 if (retrace::verbosity >= 0)
131 std::cout << "Read " << filename << "\n";
134 Image::Image src(window_width, window_height, true);
137 if (snapshot_prefix) {
138 char filename[PATH_MAX];
139 snprintf(filename, sizeof filename, "%s%010u.png", snapshot_prefix, call_no);
140 if (src.writePNG(filename) && retrace::verbosity >= 0) {
141 std::cout << "Wrote " << filename << "\n";
146 std::cout << "Snapshot " << call_no << " average precision of " << src.compare(*ref) << " bits\n";
154 static void display(void) {
157 while ((call = parser.parse_call())) {
158 const std::string &name = call->name();
160 if ((name[0] == 'w' && name[1] == 'g' && name[2] == 'l') ||
161 (name[0] == 'g' && name[1] == 'l' && name[2] == 'X')) {
162 // XXX: We ignore the majority of the OS-specific calls for now
163 if (name == "glXSwapBuffers" ||
164 name == "wglSwapBuffers") {
165 if (retrace::verbosity >= 1) {
169 frame_complete(call->no);
171 drawable->swapBuffers();
174 } else if (name == "glXMakeCurrent" ||
175 name == "wglMakeCurrent") {
177 if (!double_buffer) {
178 frame_complete(call->no);
185 if (name == "glFlush") {
187 if (!double_buffer) {
188 frame_complete(call->no);
192 retrace::retrace_call(*call);
194 if (!insideGlBeginEnd && call->no >= dump_state) {
195 state_dump(std::cout);
202 // Reached the end of trace
205 long long endTime = OS::GetTime();
206 float timeInterval = (endTime - startTime) * 1.0E-6;
208 if (retrace::verbosity >= -1) {
210 "Rendered " << frame << " frames"
211 " in " << timeInterval << " secs,"
212 " average of " << (frame/timeInterval) << " fps\n";
216 while (ws->processEvents()) {}
223 static void usage(void) {
225 "Usage: glretrace [OPTION] TRACE\n"
228 " -b benchmark (no glgeterror; no messages)\n"
229 " -c PREFIX compare against snapshots\n"
230 " -db use a double buffer visual\n"
231 " -s PREFIX take snapshots\n"
232 " -v verbose output\n"
233 " -D CALLNO dump state at specific call no\n"
234 " -w wait on final frame\n";
238 int main(int argc, char **argv)
242 for (i = 1; i < argc; ++i) {
243 const char *arg = argv[i];
249 if (!strcmp(arg, "--")) {
251 } else if (!strcmp(arg, "-b")) {
253 retrace::verbosity = -1;
254 } else if (!strcmp(arg, "-c")) {
255 compare_prefix = argv[++i];
256 } else if (!strcmp(arg, "-D")) {
257 dump_state = atoi(argv[++i]);
258 retrace::verbosity = -2;
259 } else if (!strcmp(arg, "-db")) {
260 double_buffer = true;
261 } else if (!strcmp(arg, "--help")) {
264 } else if (!strcmp(arg, "-s")) {
265 snapshot_prefix = argv[++i];
266 } else if (!strcmp(arg, "-v")) {
267 ++retrace::verbosity;
268 } else if (!strcmp(arg, "-w")) {
271 std::cerr << "error: unknown option " << arg << "\n";
277 ws = glws::createNativeWindowSystem();
278 visual = ws->createVisual(double_buffer);
279 drawable = ws->createDrawable(visual);
280 drawable->resize(window_width, window_height);
281 context = ws->createContext(visual);
282 ws->makeCurrent(drawable, context);
284 for ( ; i < argc; ++i) {
285 if (parser.open(argv[i])) {
286 startTime = OS::GetTime();
295 } /* namespace glretrace */