]> git.cworth.org Git - apitrace/blob - glretrace_main.cpp
Show call name on glGetError warning messages.
[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 "image.hpp"
30 #include "retrace.hpp"
31 #include "glproc.hpp"
32 #include "glretrace.hpp"
33
34
35 namespace glretrace {
36
37 bool double_buffer = false;
38 bool insideGlBeginEnd = false;
39 Trace::Parser parser;
40 glws::WindowSystem *ws = NULL;
41 glws::Visual *visual = NULL;
42 glws::Drawable *drawable = NULL;
43 glws::Context *context = NULL;
44
45 int window_width = 256, window_height = 256;
46
47 unsigned frame = 0;
48 long long startTime = 0;
49 bool wait = false;
50
51 bool benchmark = false;
52 const char *compare_prefix = NULL;
53 const char *snapshot_prefix = NULL;
54
55 unsigned dump_state = ~0;
56
57 void
58 checkGlError(const Trace::Call &call) {
59     if (benchmark || insideGlBeginEnd) {
60         return;
61     }
62
63     GLenum error = glGetError();
64     if (error == GL_NO_ERROR) {
65         return;
66     }
67
68     std::cerr << call.no << ": ";
69     std::cerr << "warning: glGetError(";
70     std::cerr << call.name();
71     std::cerr << ") = ";
72
73     switch (error) {
74     case GL_INVALID_ENUM:
75         std::cerr << "GL_INVALID_ENUM";
76         break;
77     case GL_INVALID_VALUE:
78         std::cerr << "GL_INVALID_VALUE";
79         break;
80     case GL_INVALID_OPERATION:
81         std::cerr << "GL_INVALID_OPERATION";
82         break;
83     case GL_STACK_OVERFLOW:
84         std::cerr << "GL_STACK_OVERFLOW";
85         break;
86     case GL_STACK_UNDERFLOW:
87         std::cerr << "GL_STACK_UNDERFLOW";
88         break;
89     case GL_OUT_OF_MEMORY:
90         std::cerr << "GL_OUT_OF_MEMORY";
91         break;
92     case GL_INVALID_FRAMEBUFFER_OPERATION:
93         std::cerr << "GL_INVALID_FRAMEBUFFER_OPERATION";
94         break;
95     case GL_TABLE_TOO_LARGE:
96         std::cerr << "GL_TABLE_TOO_LARGE";
97         break;
98     default:
99         std::cerr << error;
100         break;
101     }
102     std::cerr << "\n";
103 }
104
105
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);
113     glReadBuffer(readbuffer);
114 }
115
116
117 void frame_complete(unsigned call_no) {
118     ++frame;
119     
120     if (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);
126             if (!ref) {
127                 return;
128             }
129             if (retrace::verbosity >= 0)
130                 std::cout << "Read " << filename << "\n";
131         }
132         
133         Image::Image src(window_width, window_height, true);
134         snapshot(src);
135
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";
141             }
142         }
143
144         if (ref) {
145             std::cout << "Snapshot " << call_no << " average precision of " << src.compare(*ref) << " bits\n";
146             delete ref;
147         }
148     }
149
150 }
151
152
153 static void display(void) {
154     Trace::Call *call;
155
156     while ((call = parser.parse_call())) {
157         const std::string &name = call->name();
158
159         if (retrace::verbosity >= 1) {
160             std::cout << *call;
161             std::cout.flush();
162         }
163
164         if (name[0] == 'w' && name[1] == 'g' && name[2] == 'l') {
165             glretrace::retrace_call_wgl(*call);
166         }
167         else if (name[0] == 'g' && name[1] == 'l' && name[2] == 'X') {
168             glretrace::retrace_call_glx(*call);
169         } else {
170             retrace::retrace_call(*call);
171         }
172
173         if (!insideGlBeginEnd && call->no >= dump_state) {
174             state_dump(std::cout);
175             exit(0);
176         }
177
178         delete call;
179     }
180
181     // Reached the end of trace
182     glFlush();
183
184     long long endTime = OS::GetTime();
185     float timeInterval = (endTime - startTime) * 1.0E-6;
186
187     if (retrace::verbosity >= -1) { 
188         std::cout << 
189             "Rendered " << frame << " frames"
190             " in " <<  timeInterval << " secs,"
191             " average of " << (frame/timeInterval) << " fps\n";
192     }
193
194     if (wait) {
195         while (ws->processEvents()) {}
196     } else {
197         exit(0);
198     }
199 }
200
201
202 static void usage(void) {
203     std::cout << 
204         "Usage: glretrace [OPTION] TRACE\n"
205         "Replay TRACE.\n"
206         "\n"
207         "  -b           benchmark (no glgeterror; no messages)\n"
208         "  -c PREFIX    compare against snapshots\n"
209         "  -db          use a double buffer visual\n"
210         "  -s PREFIX    take snapshots\n"
211         "  -v           verbose output\n"
212         "  -D CALLNO    dump state at specific call no\n"
213         "  -w           wait on final frame\n";
214 }
215
216 extern "C"
217 int main(int argc, char **argv)
218 {
219
220     int i;
221     for (i = 1; i < argc; ++i) {
222         const char *arg = argv[i];
223
224         if (arg[0] != '-') {
225             break;
226         }
227
228         if (!strcmp(arg, "--")) {
229             break;
230         } else if (!strcmp(arg, "-b")) {
231             benchmark = true;
232             retrace::verbosity = -1;
233         } else if (!strcmp(arg, "-c")) {
234             compare_prefix = argv[++i];
235         } else if (!strcmp(arg, "-D")) {
236             dump_state = atoi(argv[++i]);
237             retrace::verbosity = -2;
238         } else if (!strcmp(arg, "-db")) {
239             double_buffer = true;
240         } else if (!strcmp(arg, "--help")) {
241             usage();
242             return 0;
243         } else if (!strcmp(arg, "-s")) {
244             snapshot_prefix = argv[++i];
245         } else if (!strcmp(arg, "-v")) {
246             ++retrace::verbosity;
247         } else if (!strcmp(arg, "-w")) {
248             wait = true;
249         } else {
250             std::cerr << "error: unknown option " << arg << "\n";
251             usage();
252             return 1;
253         }
254     }
255
256     ws = glws::createNativeWindowSystem();
257     visual = ws->createVisual(double_buffer);
258     drawable = ws->createDrawable(visual);
259     drawable->resize(window_width, window_height);
260     context = ws->createContext(visual);
261     ws->makeCurrent(drawable, context);
262
263     for ( ; i < argc; ++i) {
264         if (parser.open(argv[i])) {
265             startTime = OS::GetTime();
266             display();
267             parser.close();
268         }
269     }
270
271     return 0;
272 }
273
274 } /* namespace glretrace */