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 = true;
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;
53 enum frequency snapshot_frequency = FREQUENCY_NEVER;
55 unsigned dump_state = ~0;
58 checkGlError(Trace::Call &call) {
59 GLenum error = glGetError();
60 if (error == GL_NO_ERROR) {
64 if (retrace::verbosity == 0) {
69 std::cerr << call.no << ": ";
70 std::cerr << "warning: glGetError(";
71 std::cerr << call.name();
76 std::cerr << "GL_INVALID_ENUM";
78 case GL_INVALID_VALUE:
79 std::cerr << "GL_INVALID_VALUE";
81 case GL_INVALID_OPERATION:
82 std::cerr << "GL_INVALID_OPERATION";
84 case GL_STACK_OVERFLOW:
85 std::cerr << "GL_STACK_OVERFLOW";
87 case GL_STACK_UNDERFLOW:
88 std::cerr << "GL_STACK_UNDERFLOW";
90 case GL_OUT_OF_MEMORY:
91 std::cerr << "GL_OUT_OF_MEMORY";
93 case GL_INVALID_FRAMEBUFFER_OPERATION:
94 std::cerr << "GL_INVALID_FRAMEBUFFER_OPERATION";
96 case GL_TABLE_TOO_LARGE:
97 std::cerr << "GL_TABLE_TOO_LARGE";
107 * Grow the current drawble.
109 * We need to infer the drawable size from GL calls because the drawable sizes
110 * are specified by OS specific calls which we do not trace.
113 updateDrawable(int width, int height) {
118 if (width <= glretrace::drawable->width &&
119 height <= glretrace::drawable->height) {
123 // Check for bound framebuffer last, as this may have a performance impact.
124 GLint draw_framebuffer = 0;
125 glGetIntegerv(GL_DRAW_FRAMEBUFFER_BINDING, &draw_framebuffer);
126 if (draw_framebuffer != 0) {
130 glretrace::drawable->resize(width, height);
131 if (!drawable->visible) {
134 glScissor(0, 0, width, height);
138 void snapshot(unsigned call_no) {
140 (!snapshot_prefix && !compare_prefix)) {
144 Image::Image *ref = NULL;
146 if (compare_prefix) {
147 char filename[PATH_MAX];
148 snprintf(filename, sizeof filename, "%s%010u.png", compare_prefix, call_no);
149 ref = Image::readPNG(filename);
153 if (retrace::verbosity >= 0) {
154 std::cout << "Read " << filename << "\n";
158 Image::Image *src = glstate::getDrawBufferImage(GL_RGBA);
163 if (snapshot_prefix) {
164 if (snapshot_prefix[0] == '-' && snapshot_prefix[1] == 0) {
166 snprintf(comment, sizeof comment, "%u", call_no);
167 src->writePNM(std::cout, comment);
169 char filename[PATH_MAX];
170 snprintf(filename, sizeof filename, "%s%010u.png", snapshot_prefix, call_no);
171 if (src->writePNG(filename) && retrace::verbosity >= 0) {
172 std::cout << "Wrote " << filename << "\n";
178 std::cout << "Snapshot " << call_no << " average precision of " << src->compare(*ref) << " bits\n";
186 void frame_complete(unsigned call_no) {
189 if (snapshot_frequency == FREQUENCY_FRAME ||
190 snapshot_frequency == FREQUENCY_FRAMEBUFFER) {
196 static void display(void) {
197 startTime = OS::GetTime();
200 while ((call = parser.parse_call())) {
201 const char *name = call->name();
203 if (retrace::verbosity >= 1) {
208 if (name[0] == 'C' && name[1] == 'G' && name[2] == 'L') {
209 glretrace::retrace_call_cgl(*call);
211 else if (name[0] == 'w' && name[1] == 'g' && name[2] == 'l') {
212 glretrace::retrace_call_wgl(*call);
214 else if (name[0] == 'g' && name[1] == 'l' && name[2] == 'X') {
215 glretrace::retrace_call_glx(*call);
217 retrace::retrace_call(*call);
220 if (!insideGlBeginEnd &&
221 drawable && context &&
222 call->no >= dump_state) {
223 glstate::dumpCurrentContext(std::cout);
230 // Reached the end of trace
233 long long endTime = OS::GetTime();
234 float timeInterval = (endTime - startTime) * 1.0E-6;
236 if (retrace::verbosity >= -1) {
238 "Rendered " << frame << " frames"
239 " in " << timeInterval << " secs,"
240 " average of " << (frame/timeInterval) << " fps\n";
244 while (ws->processEvents()) {}
251 static void usage(void) {
253 "Usage: glretrace [OPTION] TRACE\n"
256 " -b benchmark mode (no error checking or warning messages)\n"
257 " -c PREFIX compare against snapshots\n"
258 " -db use a double buffer visual (default)\n"
259 " -sb use a single buffer visual\n"
260 " -s PREFIX take snapshots; `-` for PNM stdout output\n"
261 " -S FREQUENCY snapshot frequency: frame (default), framebuffer, or draw\n"
262 " -v verbose output\n"
263 " -D CALLNO dump state at specific call no\n"
264 " -w wait on final frame\n";
268 int main(int argc, char **argv)
272 for (i = 1; i < argc; ++i) {
273 const char *arg = argv[i];
279 if (!strcmp(arg, "--")) {
281 } else if (!strcmp(arg, "-b")) {
283 retrace::verbosity = -1;
284 } else if (!strcmp(arg, "-c")) {
285 compare_prefix = argv[++i];
286 if (snapshot_frequency == FREQUENCY_NEVER) {
287 snapshot_frequency = FREQUENCY_FRAME;
289 } else if (!strcmp(arg, "-D")) {
290 dump_state = atoi(argv[++i]);
291 retrace::verbosity = -2;
292 } else if (!strcmp(arg, "-db")) {
293 double_buffer = true;
294 } else if (!strcmp(arg, "-sb")) {
295 double_buffer = false;
296 } else if (!strcmp(arg, "--help")) {
299 } else if (!strcmp(arg, "-s")) {
300 snapshot_prefix = argv[++i];
301 if (snapshot_frequency == FREQUENCY_NEVER) {
302 snapshot_frequency = FREQUENCY_FRAME;
304 if (snapshot_prefix[0] == '-' && snapshot_prefix[1] == 0) {
305 retrace::verbosity = -2;
307 } else if (!strcmp(arg, "-S")) {
309 if (!strcmp(arg, "frame")) {
310 snapshot_frequency = FREQUENCY_FRAME;
311 } else if (!strcmp(arg, "framebuffer")) {
312 snapshot_frequency = FREQUENCY_FRAMEBUFFER;
313 } else if (!strcmp(arg, "draw")) {
314 snapshot_frequency = FREQUENCY_DRAW;
316 std::cerr << "error: unknown frequency " << arg << "\n";
320 if (snapshot_prefix == NULL) {
321 snapshot_prefix = "";
323 } else if (!strcmp(arg, "-v")) {
324 ++retrace::verbosity;
325 } else if (!strcmp(arg, "-w")) {
328 std::cerr << "error: unknown option " << arg << "\n";
334 ws = glws::createNativeWindowSystem();
335 visual = ws->createVisual(double_buffer);
337 for ( ; i < argc; ++i) {
338 if (!parser.open(argv[i])) {
339 std::cerr << "error: failed to open " << argv[i] << "\n";
351 } /* namespace glretrace */