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 "glstate.hpp"
33 #include "glretrace.hpp"
38 bool double_buffer = false;
39 bool insideGlBeginEnd = false;
41 glws::WindowSystem *ws = NULL;
42 glws::Visual *visual = NULL;
43 glws::Drawable *drawable = NULL;
44 glws::Context *context = NULL;
47 long long startTime = 0;
50 bool benchmark = false;
51 const char *compare_prefix = NULL;
52 const char *snapshot_prefix = NULL;
54 unsigned dump_state = ~0;
57 checkGlError(Trace::Call &call) {
58 GLenum error = glGetError();
59 if (error == GL_NO_ERROR) {
63 if (retrace::verbosity == 0) {
68 std::cerr << call.no << ": ";
69 std::cerr << "warning: glGetError(";
70 std::cerr << call.name();
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 color_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);
113 glPushClientAttrib(GL_CLIENT_PIXEL_STORE_BIT);
114 glPixelStorei(GL_PACK_SWAP_BYTES, GL_FALSE);
115 glPixelStorei(GL_PACK_LSB_FIRST, GL_FALSE);
116 glPixelStorei(GL_PACK_ROW_LENGTH, 0);
117 glPixelStorei(GL_PACK_IMAGE_HEIGHT, 0);
118 glPixelStorei(GL_PACK_SKIP_ROWS, 0);
119 glPixelStorei(GL_PACK_SKIP_PIXELS, 0);
120 glPixelStorei(GL_PACK_SKIP_IMAGES, 0);
121 glPixelStorei(GL_PACK_ALIGNMENT, 1);
123 glReadPixels(0, 0, image.width, image.height, GL_RGBA, GL_UNSIGNED_BYTE, image.pixels);
127 glReadBuffer(readbuffer);
131 void snapshot(unsigned call_no) {
133 (!snapshot_prefix && !compare_prefix)) {
137 Image::Image *ref = NULL;
139 if (compare_prefix) {
140 char filename[PATH_MAX];
141 snprintf(filename, sizeof filename, "%s%010u.png", compare_prefix, call_no);
142 ref = Image::readPNG(filename);
146 if (retrace::verbosity >= 0) {
147 std::cout << "Read " << filename << "\n";
151 Image::Image src(drawable->width, drawable->height, true);
154 if (snapshot_prefix) {
155 char filename[PATH_MAX];
156 snprintf(filename, sizeof filename, "%s%010u.png", snapshot_prefix, call_no);
157 if (src.writePNG(filename) && retrace::verbosity >= 0) {
158 std::cout << "Wrote " << filename << "\n";
163 std::cout << "Snapshot " << call_no << " average precision of " << src.compare(*ref) << " bits\n";
169 void frame_complete(unsigned call_no) {
176 static void display(void) {
179 while ((call = parser.parse_call())) {
180 const std::string &name = call->name();
182 if (retrace::verbosity >= 1) {
187 if (name[0] == 'C' && name[1] == 'G' && name[2] == 'L') {
188 glretrace::retrace_call_cgl(*call);
190 else if (name[0] == 'w' && name[1] == 'g' && name[2] == 'l') {
191 glretrace::retrace_call_wgl(*call);
193 else if (name[0] == 'g' && name[1] == 'l' && name[2] == 'X') {
194 glretrace::retrace_call_glx(*call);
196 retrace::retrace_call(*call);
199 if (!insideGlBeginEnd &&
200 drawable && context &&
201 call->no >= dump_state) {
202 glstate::dumpCurrentContext(std::cout);
209 // Reached the end of trace
212 long long endTime = OS::GetTime();
213 float timeInterval = (endTime - startTime) * 1.0E-6;
215 if (retrace::verbosity >= -1) {
217 "Rendered " << frame << " frames"
218 " in " << timeInterval << " secs,"
219 " average of " << (frame/timeInterval) << " fps\n";
223 while (ws->processEvents()) {}
230 static void usage(void) {
232 "Usage: glretrace [OPTION] TRACE\n"
235 " -b benchmark (no glgeterror; no messages)\n"
236 " -c PREFIX compare against snapshots\n"
237 " -db use a double buffer visual\n"
238 " -s PREFIX take snapshots\n"
239 " -v verbose output\n"
240 " -D CALLNO dump state at specific call no\n"
241 " -w wait on final frame\n";
245 int main(int argc, char **argv)
249 for (i = 1; i < argc; ++i) {
250 const char *arg = argv[i];
256 if (!strcmp(arg, "--")) {
258 } else if (!strcmp(arg, "-b")) {
260 retrace::verbosity = -1;
261 } else if (!strcmp(arg, "-c")) {
262 compare_prefix = argv[++i];
263 } else if (!strcmp(arg, "-D")) {
264 dump_state = atoi(argv[++i]);
265 retrace::verbosity = -2;
266 } else if (!strcmp(arg, "-db")) {
267 double_buffer = true;
268 } else if (!strcmp(arg, "--help")) {
271 } else if (!strcmp(arg, "-s")) {
272 snapshot_prefix = argv[++i];
273 } else if (!strcmp(arg, "-v")) {
274 ++retrace::verbosity;
275 } else if (!strcmp(arg, "-w")) {
278 std::cerr << "error: unknown option " << arg << "\n";
284 ws = glws::createNativeWindowSystem();
285 visual = ws->createVisual(double_buffer);
287 for ( ; i < argc; ++i) {
288 if (parser.open(argv[i])) {
289 startTime = OS::GetTime();
298 } /* namespace glretrace */