]> git.cworth.org Git - apitrace/blob - glretrace_main.cpp
Reset all pixel store state before snapshoting.
[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 unsigned frame = 0;
46 long long startTime = 0;
47 bool wait = false;
48
49 bool benchmark = false;
50 const char *compare_prefix = NULL;
51 const char *snapshot_prefix = NULL;
52
53 unsigned dump_state = ~0;
54
55 void
56 checkGlError(Trace::Call &call) {
57     if (benchmark || insideGlBeginEnd) {
58         return;
59     }
60
61     GLenum error = glGetError();
62     if (error == GL_NO_ERROR) {
63         return;
64     }
65
66     if (retrace::verbosity == 0) {
67         std::cout << call;
68         std::cout.flush();
69     }
70
71     std::cerr << call.no << ": ";
72     std::cerr << "warning: glGetError(";
73     std::cerr << call.name();
74     std::cerr << ") = ";
75
76     switch (error) {
77     case GL_INVALID_ENUM:
78         std::cerr << "GL_INVALID_ENUM";
79         break;
80     case GL_INVALID_VALUE:
81         std::cerr << "GL_INVALID_VALUE";
82         break;
83     case GL_INVALID_OPERATION:
84         std::cerr << "GL_INVALID_OPERATION";
85         break;
86     case GL_STACK_OVERFLOW:
87         std::cerr << "GL_STACK_OVERFLOW";
88         break;
89     case GL_STACK_UNDERFLOW:
90         std::cerr << "GL_STACK_UNDERFLOW";
91         break;
92     case GL_OUT_OF_MEMORY:
93         std::cerr << "GL_OUT_OF_MEMORY";
94         break;
95     case GL_INVALID_FRAMEBUFFER_OPERATION:
96         std::cerr << "GL_INVALID_FRAMEBUFFER_OPERATION";
97         break;
98     case GL_TABLE_TOO_LARGE:
99         std::cerr << "GL_TABLE_TOO_LARGE";
100         break;
101     default:
102         std::cerr << error;
103         break;
104     }
105     std::cerr << "\n";
106 }
107
108
109 static void snapshot(Image::Image &image) {
110     GLint drawbuffer = double_buffer ? GL_BACK : GL_FRONT;
111     GLint readbuffer = double_buffer ? GL_BACK : GL_FRONT;
112     glGetIntegerv(GL_DRAW_BUFFER, &drawbuffer);
113     glGetIntegerv(GL_READ_BUFFER, &readbuffer);
114     glReadBuffer(drawbuffer);
115
116     glPushClientAttrib(GL_CLIENT_PIXEL_STORE_BIT);
117     glPixelStorei(GL_PACK_SWAP_BYTES, GL_FALSE);
118     glPixelStorei(GL_PACK_LSB_FIRST, GL_FALSE);
119     glPixelStorei(GL_PACK_ROW_LENGTH, 0);
120     glPixelStorei(GL_PACK_IMAGE_HEIGHT, 0);
121     glPixelStorei(GL_PACK_SKIP_ROWS, 0);
122     glPixelStorei(GL_PACK_SKIP_PIXELS, 0);
123     glPixelStorei(GL_PACK_SKIP_IMAGES, 0);
124     glPixelStorei(GL_PACK_ALIGNMENT, 1);
125
126     glReadPixels(0, 0, image.width, image.height, GL_RGBA, GL_UNSIGNED_BYTE, image.pixels);
127     
128     glPopClientAttrib();
129
130     glReadBuffer(readbuffer);
131 }
132
133
134 void frame_complete(unsigned call_no) {
135     ++frame;
136     
137     if (drawable &&
138         (snapshot_prefix || compare_prefix)) {
139         Image::Image *ref = NULL;
140         if (compare_prefix) {
141             char filename[PATH_MAX];
142             snprintf(filename, sizeof filename, "%s%010u.png", compare_prefix, call_no);
143             ref = Image::readPNG(filename);
144             if (!ref) {
145                 return;
146             }
147             if (retrace::verbosity >= 0)
148                 std::cout << "Read " << filename << "\n";
149         }
150         
151         Image::Image src(drawable->width, drawable->height, true);
152         snapshot(src);
153
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";
159             }
160         }
161
162         if (ref) {
163             std::cout << "Snapshot " << call_no << " average precision of " << src.compare(*ref) << " bits\n";
164             delete ref;
165         }
166     }
167
168 }
169
170
171 static void display(void) {
172     Trace::Call *call;
173
174     while ((call = parser.parse_call())) {
175         const std::string &name = call->name();
176
177         if (retrace::verbosity >= 1) {
178             std::cout << *call;
179             std::cout.flush();
180         }
181
182         if (name[0] == 'w' && name[1] == 'g' && name[2] == 'l') {
183             glretrace::retrace_call_wgl(*call);
184         }
185         else if (name[0] == 'g' && name[1] == 'l' && name[2] == 'X') {
186             glretrace::retrace_call_glx(*call);
187         } else {
188             retrace::retrace_call(*call);
189         }
190
191         if (!insideGlBeginEnd &&
192             drawable && context &&
193             call->no >= dump_state) {
194             state_dump(std::cout);
195             exit(0);
196         }
197
198         delete call;
199     }
200
201     // Reached the end of trace
202     glFlush();
203
204     long long endTime = OS::GetTime();
205     float timeInterval = (endTime - startTime) * 1.0E-6;
206
207     if (retrace::verbosity >= -1) { 
208         std::cout << 
209             "Rendered " << frame << " frames"
210             " in " <<  timeInterval << " secs,"
211             " average of " << (frame/timeInterval) << " fps\n";
212     }
213
214     if (wait) {
215         while (ws->processEvents()) {}
216     } else {
217         exit(0);
218     }
219 }
220
221
222 static void usage(void) {
223     std::cout << 
224         "Usage: glretrace [OPTION] TRACE\n"
225         "Replay TRACE.\n"
226         "\n"
227         "  -b           benchmark (no glgeterror; no messages)\n"
228         "  -c PREFIX    compare against snapshots\n"
229         "  -db          use a double buffer visual\n"
230         "  -s PREFIX    take snapshots\n"
231         "  -v           verbose output\n"
232         "  -D CALLNO    dump state at specific call no\n"
233         "  -w           wait on final frame\n";
234 }
235
236 extern "C"
237 int main(int argc, char **argv)
238 {
239
240     int i;
241     for (i = 1; i < argc; ++i) {
242         const char *arg = argv[i];
243
244         if (arg[0] != '-') {
245             break;
246         }
247
248         if (!strcmp(arg, "--")) {
249             break;
250         } else if (!strcmp(arg, "-b")) {
251             benchmark = true;
252             retrace::verbosity = -1;
253         } else if (!strcmp(arg, "-c")) {
254             compare_prefix = argv[++i];
255         } else if (!strcmp(arg, "-D")) {
256             dump_state = atoi(argv[++i]);
257             retrace::verbosity = -2;
258         } else if (!strcmp(arg, "-db")) {
259             double_buffer = true;
260         } else if (!strcmp(arg, "--help")) {
261             usage();
262             return 0;
263         } else if (!strcmp(arg, "-s")) {
264             snapshot_prefix = argv[++i];
265         } else if (!strcmp(arg, "-v")) {
266             ++retrace::verbosity;
267         } else if (!strcmp(arg, "-w")) {
268             wait = true;
269         } else {
270             std::cerr << "error: unknown option " << arg << "\n";
271             usage();
272             return 1;
273         }
274     }
275
276     ws = glws::createNativeWindowSystem();
277     visual = ws->createVisual(double_buffer);
278
279     for ( ; i < argc; ++i) {
280         if (parser.open(argv[i])) {
281             startTime = OS::GetTime();
282             display();
283             parser.close();
284         }
285     }
286
287     return 0;
288 }
289
290 } /* namespace glretrace */