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;
46 long long startTime = 0;
49 bool benchmark = false;
50 const char *compare_prefix = NULL;
51 const char *snapshot_prefix = NULL;
53 unsigned dump_state = ~0;
56 checkGlError(int callIdx) {
57 if (benchmark || insideGlBeginEnd) {
61 GLenum error = glGetError();
62 if (error == GL_NO_ERROR) {
67 std::cerr << callIdx << ": ";
70 std::cerr << "warning: glGetError() = ";
73 std::cerr << "GL_INVALID_ENUM";
75 case GL_INVALID_VALUE:
76 std::cerr << "GL_INVALID_VALUE";
78 case GL_INVALID_OPERATION:
79 std::cerr << "GL_INVALID_OPERATION";
81 case GL_STACK_OVERFLOW:
82 std::cerr << "GL_STACK_OVERFLOW";
84 case GL_STACK_UNDERFLOW:
85 std::cerr << "GL_STACK_UNDERFLOW";
87 case GL_OUT_OF_MEMORY:
88 std::cerr << "GL_OUT_OF_MEMORY";
90 case GL_INVALID_FRAMEBUFFER_OPERATION:
91 std::cerr << "GL_INVALID_FRAMEBUFFER_OPERATION";
93 case GL_TABLE_TOO_LARGE:
94 std::cerr << "GL_TABLE_TOO_LARGE";
104 static void snapshot(Image::Image &image) {
105 GLint drawbuffer = double_buffer ? GL_BACK : GL_FRONT;
106 GLint readbuffer = double_buffer ? GL_BACK : GL_FRONT;
107 glGetIntegerv(GL_DRAW_BUFFER, &drawbuffer);
108 glGetIntegerv(GL_READ_BUFFER, &readbuffer);
109 glReadBuffer(drawbuffer);
110 glReadPixels(0, 0, image.width, image.height, GL_RGBA, GL_UNSIGNED_BYTE, image.pixels);
112 glReadBuffer(readbuffer);
116 void frame_complete(unsigned call_no) {
120 (snapshot_prefix || compare_prefix)) {
121 Image::Image *ref = NULL;
122 if (compare_prefix) {
123 char filename[PATH_MAX];
124 snprintf(filename, sizeof filename, "%s%010u.png", compare_prefix, call_no);
125 ref = Image::readPNG(filename);
129 if (retrace::verbosity >= 0)
130 std::cout << "Read " << filename << "\n";
133 Image::Image src(drawable->width, drawable->height, true);
136 if (snapshot_prefix) {
137 char filename[PATH_MAX];
138 snprintf(filename, sizeof filename, "%s%010u.png", snapshot_prefix, call_no);
139 if (src.writePNG(filename) && retrace::verbosity >= 0) {
140 std::cout << "Wrote " << filename << "\n";
145 std::cout << "Snapshot " << call_no << " average precision of " << src.compare(*ref) << " bits\n";
153 static void display(void) {
156 while ((call = parser.parse_call())) {
157 const std::string &name = call->name();
159 if (retrace::verbosity >= 1) {
164 if (name[0] == 'w' && name[1] == 'g' && name[2] == 'l') {
165 glretrace::retrace_call_wgl(*call);
167 else if (name[0] == 'g' && name[1] == 'l' && name[2] == 'X') {
168 glretrace::retrace_call_glx(*call);
170 retrace::retrace_call(*call);
173 if (!insideGlBeginEnd &&
174 drawable && context &&
175 call->no >= dump_state) {
176 state_dump(std::cout);
183 // Reached the end of trace
186 long long endTime = OS::GetTime();
187 float timeInterval = (endTime - startTime) * 1.0E-6;
189 if (retrace::verbosity >= -1) {
191 "Rendered " << frame << " frames"
192 " in " << timeInterval << " secs,"
193 " average of " << (frame/timeInterval) << " fps\n";
197 while (ws->processEvents()) {}
204 static void usage(void) {
206 "Usage: glretrace [OPTION] TRACE\n"
209 " -b benchmark (no glgeterror; no messages)\n"
210 " -c PREFIX compare against snapshots\n"
211 " -db use a double buffer visual\n"
212 " -s PREFIX take snapshots\n"
213 " -v verbose output\n"
214 " -D CALLNO dump state at specific call no\n"
215 " -w wait on final frame\n";
219 int main(int argc, char **argv)
223 for (i = 1; i < argc; ++i) {
224 const char *arg = argv[i];
230 if (!strcmp(arg, "--")) {
232 } else if (!strcmp(arg, "-b")) {
234 retrace::verbosity = -1;
235 } else if (!strcmp(arg, "-c")) {
236 compare_prefix = argv[++i];
237 } else if (!strcmp(arg, "-D")) {
238 dump_state = atoi(argv[++i]);
239 retrace::verbosity = -2;
240 } else if (!strcmp(arg, "-db")) {
241 double_buffer = true;
242 } else if (!strcmp(arg, "--help")) {
245 } else if (!strcmp(arg, "-s")) {
246 snapshot_prefix = argv[++i];
247 } else if (!strcmp(arg, "-v")) {
248 ++retrace::verbosity;
249 } else if (!strcmp(arg, "-w")) {
252 std::cerr << "error: unknown option " << arg << "\n";
258 ws = glws::createNativeWindowSystem();
259 visual = ws->createVisual(double_buffer);
261 for ( ; i < argc; ++i) {
262 if (parser.open(argv[i])) {
263 startTime = OS::GetTime();
272 } /* namespace glretrace */