]> git.cworth.org Git - apitrace/blob - glretrace_main.cpp
Move os::Path to a separate header.
[apitrace] / glretrace_main.cpp
1 /**************************************************************************
2  *
3  * Copyright 2011 Jose Fonseca
4  * All Rights Reserved.
5  *
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:
12  *
13  * The above copyright notice and this permission notice shall be included in
14  * all copies or substantial portions of the Software.
15  *
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
22  * THE SOFTWARE.
23  *
24  **************************************************************************/
25
26
27 #include <string.h>
28
29 #include "os_path.hpp"
30 #include "image.hpp"
31 #include "retrace.hpp"
32 #include "glproc.hpp"
33 #include "glstate.hpp"
34 #include "glretrace.hpp"
35
36
37 namespace glretrace {
38
39 bool double_buffer = true;
40 bool insideGlBeginEnd = false;
41 trace::Parser parser;
42 glws::Visual *visual = NULL;
43 glws::Drawable *drawable = NULL;
44 glws::Context *context = NULL;
45
46 unsigned frame = 0;
47 long long startTime = 0;
48 bool wait = false;
49
50 bool benchmark = false;
51 const char *compare_prefix = NULL;
52 const char *snapshot_prefix = NULL;
53 enum frequency snapshot_frequency = FREQUENCY_NEVER;
54
55 unsigned dump_state = ~0;
56
57 void
58 checkGlError(trace::Call &call) {
59     GLenum error = glGetError();
60     if (error == GL_NO_ERROR) {
61         return;
62     }
63
64     std::ostream & os = retrace::warning(call);
65
66     os << "glGetError(";
67     os << call.name();
68     os << ") = ";
69
70     switch (error) {
71     case GL_INVALID_ENUM:
72         os << "GL_INVALID_ENUM";
73         break;
74     case GL_INVALID_VALUE:
75         os << "GL_INVALID_VALUE";
76         break;
77     case GL_INVALID_OPERATION:
78         os << "GL_INVALID_OPERATION";
79         break;
80     case GL_STACK_OVERFLOW:
81         os << "GL_STACK_OVERFLOW";
82         break;
83     case GL_STACK_UNDERFLOW:
84         os << "GL_STACK_UNDERFLOW";
85         break;
86     case GL_OUT_OF_MEMORY:
87         os << "GL_OUT_OF_MEMORY";
88         break;
89     case GL_INVALID_FRAMEBUFFER_OPERATION:
90         os << "GL_INVALID_FRAMEBUFFER_OPERATION";
91         break;
92     case GL_TABLE_TOO_LARGE:
93         os << "GL_TABLE_TOO_LARGE";
94         break;
95     default:
96         os << error;
97         break;
98     }
99     os << "\n";
100 }
101
102 /**
103  * Grow the current drawble.
104  *
105  * We need to infer the drawable size from GL calls because the drawable sizes
106  * are specified by OS specific calls which we do not trace.
107  */
108 void
109 updateDrawable(int width, int height) {
110     if (!drawable) {
111         return;
112     }
113
114     if (drawable->visible &&
115         width  <= drawable->width &&
116         height <= drawable->height) {
117         return;
118     }
119
120     // Check for bound framebuffer last, as this may have a performance impact.
121     GLint draw_framebuffer = 0;
122     glGetIntegerv(GL_DRAW_FRAMEBUFFER_BINDING, &draw_framebuffer);
123     if (draw_framebuffer != 0) {
124         return;
125     }
126
127     drawable->resize(width, height);
128     drawable->show();
129
130     glScissor(0, 0, width, height);
131 }
132
133
134 void snapshot(unsigned call_no) {
135     if (!drawable ||
136         (!snapshot_prefix && !compare_prefix)) {
137         return;
138     }
139
140     image::Image *ref = NULL;
141
142     if (compare_prefix) {
143         os::Path filename = os::Path::format("%s%010u.png", compare_prefix, call_no);
144         ref = image::readPNG(filename);
145         if (!ref) {
146             return;
147         }
148         if (retrace::verbosity >= 0) {
149             std::cout << "Read " << filename << "\n";
150         }
151     }
152
153     image::Image *src = glstate::getDrawBufferImage(GL_RGBA);
154     if (!src) {
155         return;
156     }
157
158     if (snapshot_prefix) {
159         if (snapshot_prefix[0] == '-' && snapshot_prefix[1] == 0) {
160             char comment[21];
161             snprintf(comment, sizeof comment, "%u", call_no);
162             src->writePNM(std::cout, comment);
163         } else {
164             os::Path filename = os::Path::format("%s%010u.png", snapshot_prefix, call_no);
165             if (src->writePNG(filename) && retrace::verbosity >= 0) {
166                 std::cout << "Wrote " << filename << "\n";
167             }
168         }
169     }
170
171     if (ref) {
172         std::cout << "Snapshot " << call_no << " average precision of " << src->compare(*ref) << " bits\n";
173         delete ref;
174     }
175
176     delete src;
177 }
178
179
180 void frame_complete(trace::Call &call) {
181     ++frame;
182
183     if (!drawable) {
184         return;
185     }
186
187     if (!drawable->visible) {
188         retrace::warning(call) << "could not infer drawable size (glViewport never called)\n";
189     }
190
191     if (snapshot_frequency == FREQUENCY_FRAME ||
192         snapshot_frequency == FREQUENCY_FRAMEBUFFER) {
193         snapshot(call.no);
194     }
195 }
196
197
198 static void display(void) {
199     retrace::Retracer retracer;
200
201     retracer.addCallbacks(gl_callbacks);
202     retracer.addCallbacks(glx_callbacks);
203     retracer.addCallbacks(wgl_callbacks);
204     retracer.addCallbacks(cgl_callbacks);
205
206     startTime = os::getTime();
207     trace::Call *call;
208
209     while ((call = parser.parse_call())) {
210         retracer.retrace(*call);
211
212         if (!insideGlBeginEnd &&
213             drawable && context &&
214             call->no >= dump_state) {
215             glstate::dumpCurrentContext(std::cout);
216             exit(0);
217         }
218
219         delete call;
220     }
221
222     // Reached the end of trace
223     glFlush();
224
225     long long endTime = os::getTime();
226     float timeInterval = (endTime - startTime) * 1.0E-6;
227
228     if (retrace::verbosity >= -1) { 
229         std::cout << 
230             "Rendered " << frame << " frames"
231             " in " <<  timeInterval << " secs,"
232             " average of " << (frame/timeInterval) << " fps\n";
233     }
234
235     if (wait) {
236         while (glws::processEvents()) {}
237     } else {
238         exit(0);
239     }
240 }
241
242
243 static void usage(void) {
244     std::cout << 
245         "Usage: glretrace [OPTION] TRACE\n"
246         "Replay TRACE.\n"
247         "\n"
248         "  -b           benchmark mode (no error checking or warning messages)\n"
249         "  -c PREFIX    compare against snapshots\n"
250         "  -db          use a double buffer visual (default)\n"
251         "  -sb          use a single buffer visual\n"
252         "  -s PREFIX    take snapshots; `-` for PNM stdout output\n"
253         "  -S FREQUENCY snapshot frequency: frame (default), framebuffer, or draw\n"
254         "  -v           verbose output\n"
255         "  -D CALLNO    dump state at specific call no\n"
256         "  -w           wait on final frame\n";
257 }
258
259 extern "C"
260 int main(int argc, char **argv)
261 {
262
263     int i;
264     for (i = 1; i < argc; ++i) {
265         const char *arg = argv[i];
266
267         if (arg[0] != '-') {
268             break;
269         }
270
271         if (!strcmp(arg, "--")) {
272             break;
273         } else if (!strcmp(arg, "-b")) {
274             benchmark = true;
275             retrace::verbosity = -1;
276             glws::debug = false;
277         } else if (!strcmp(arg, "-c")) {
278             compare_prefix = argv[++i];
279             if (snapshot_frequency == FREQUENCY_NEVER) {
280                 snapshot_frequency = FREQUENCY_FRAME;
281             }
282         } else if (!strcmp(arg, "-D")) {
283             dump_state = atoi(argv[++i]);
284             retrace::verbosity = -2;
285         } else if (!strcmp(arg, "-db")) {
286             double_buffer = true;
287         } else if (!strcmp(arg, "-sb")) {
288             double_buffer = false;
289         } else if (!strcmp(arg, "--help")) {
290             usage();
291             return 0;
292         } else if (!strcmp(arg, "-s")) {
293             snapshot_prefix = argv[++i];
294             if (snapshot_frequency == FREQUENCY_NEVER) {
295                 snapshot_frequency = FREQUENCY_FRAME;
296             }
297             if (snapshot_prefix[0] == '-' && snapshot_prefix[1] == 0) {
298                 retrace::verbosity = -2;
299             }
300         } else if (!strcmp(arg, "-S")) {
301             arg = argv[++i];
302             if (!strcmp(arg, "frame")) {
303                 snapshot_frequency = FREQUENCY_FRAME;
304             } else if (!strcmp(arg, "framebuffer")) {
305                 snapshot_frequency = FREQUENCY_FRAMEBUFFER;
306             } else if (!strcmp(arg, "draw")) {
307                 snapshot_frequency = FREQUENCY_DRAW;
308             } else {
309                 std::cerr << "error: unknown frequency " << arg << "\n";
310                 usage();
311                 return 1;
312             }
313             if (snapshot_prefix == NULL) {
314                 snapshot_prefix = "";
315             }
316         } else if (!strcmp(arg, "-v")) {
317             ++retrace::verbosity;
318         } else if (!strcmp(arg, "-w")) {
319             wait = true;
320         } else {
321             std::cerr << "error: unknown option " << arg << "\n";
322             usage();
323             return 1;
324         }
325     }
326
327     glws::init();
328     visual = glws::createVisual(double_buffer);
329
330     for ( ; i < argc; ++i) {
331         if (!parser.open(argv[i])) {
332             std::cerr << "error: failed to open " << argv[i] << "\n";
333             return 1;
334         }
335
336         display();
337
338         parser.close();
339     }
340     
341     delete visual;
342     glws::cleanup();
343
344     return 0;
345 }
346
347 } /* namespace glretrace */