git.cworth.org Git - apitrace/blob - 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 "glstate.hpp"
  33 #include "glretrace.hpp"
  34
  35
  36 namespace glretrace {
  37
  38 bool double_buffer = true;
  39 bool insideGlBeginEnd = false;
  40 Trace::Parser parser;
  41 glws::WindowSystem *ws = NULL;
  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     if (retrace::verbosity == 0) {
  65         std::cout << call;
  66         std::cout.flush();
  67     }
  68
  69     std::cerr << call.no << ": ";
  70     std::cerr << "warning: glGetError(";
  71     std::cerr << call.name();
  72     std::cerr << ") = ";
  73
  74     switch (error) {
  75     case GL_INVALID_ENUM:
  76         std::cerr << "GL_INVALID_ENUM";
  77         break;
  78     case GL_INVALID_VALUE:
  79         std::cerr << "GL_INVALID_VALUE";
  80         break;
  81     case GL_INVALID_OPERATION:
  82         std::cerr << "GL_INVALID_OPERATION";
  83         break;
  84     case GL_STACK_OVERFLOW:
  85         std::cerr << "GL_STACK_OVERFLOW";
  86         break;
  87     case GL_STACK_UNDERFLOW:
  88         std::cerr << "GL_STACK_UNDERFLOW";
  89         break;
  90     case GL_OUT_OF_MEMORY:
  91         std::cerr << "GL_OUT_OF_MEMORY";
  92         break;
  93     case GL_INVALID_FRAMEBUFFER_OPERATION:
  94         std::cerr << "GL_INVALID_FRAMEBUFFER_OPERATION";
  95         break;
  96     case GL_TABLE_TOO_LARGE:
  97         std::cerr << "GL_TABLE_TOO_LARGE";
  98         break;
  99     default:
 100         std::cerr << error;
 101         break;
 102     }
 103     std::cerr << "\n";
 104 }
 105
 106 /**
 107  * Grow the current drawble.
 108  *
 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.
 111  */
 112 void
 113 updateDrawable(int width, int height) {
 114     if (!drawable) {
 115         return;
 116     }
 117
 118     if (width  <= glretrace::drawable->width &&
 119         height <= glretrace::drawable->height) {
 120         return;
 121     }
 122
 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) {
 127         return;
 128     }
 129
 130     glretrace::drawable->resize(width, height);
 131     if (!drawable->visible) {
 132         drawable->show();
 133     }
 134     glScissor(0, 0, width, height);
 135 }
 136
 137
 138 void snapshot(unsigned call_no) {
 139     if (!drawable ||
 140         (!snapshot_prefix && !compare_prefix)) {
 141         return;
 142     }
 143
 144     Image::Image *ref = NULL;
 145
 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);
 150         if (!ref) {
 151             return;
 152         }
 153         if (retrace::verbosity >= 0) {
 154             std::cout << "Read " << filename << "\n";
 155         }
 156     }
 157
 158     Image::Image *src = glstate::getDrawBufferImage(GL_RGBA);
 159     if (!src) {
 160         return;
 161     }
 162
 163     if (snapshot_prefix) {
 164         if (snapshot_prefix[0] == '-' && snapshot_prefix[1] == 0) {
 165             char comment[21];
 166             snprintf(comment, sizeof comment, "%u", call_no);
 167             src->writePNM(std::cout, comment);
 168         } else {
 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";
 173             }
 174         }
 175     }
 176
 177     if (ref) {
 178         std::cout << "Snapshot " << call_no << " average precision of " << src->compare(*ref) << " bits\n";
 179         delete ref;
 180     }
 181
 182     delete src;
 183 }
 184
 185
 186 void frame_complete(unsigned call_no) {
 187     ++frame;
 188
 189     if (snapshot_frequency == FREQUENCY_FRAME ||
 190         snapshot_frequency == FREQUENCY_FRAMEBUFFER) {
 191         snapshot(call_no);
 192     }
 193 }
 194
 195
 196 static void display(void) {
 197     retrace::Retracer retracer;
 198
 199     retracer.addCallbacks(gl_callbacks);
 200     retracer.addCallbacks(glx_callbacks);
 201     retracer.addCallbacks(wgl_callbacks);
 202     retracer.addCallbacks(cgl_callbacks);
 203
 204     startTime = OS::GetTime();
 205     Trace::Call *call;
 206
 207     while ((call = parser.parse_call())) {
 208         if (retrace::verbosity >= 1) {
 209             std::cout << *call;
 210             std::cout.flush();
 211         }
 212
 213         retracer.retrace(*call);
 214
 215         if (!insideGlBeginEnd &&
 216             drawable && context &&
 217             call->no >= dump_state) {
 218             glstate::dumpCurrentContext(std::cout);
 219             exit(0);
 220         }
 221
 222         delete call;
 223     }
 224
 225     // Reached the end of trace
 226     glFlush();
 227
 228     long long endTime = OS::GetTime();
 229     float timeInterval = (endTime - startTime) * 1.0E-6;
 230
 231     if (retrace::verbosity >= -1) {
 232         std::cout <<
 233             "Rendered " << frame << " frames"
 234             " in " <<  timeInterval << " secs,"
 235             " average of " << (frame/timeInterval) << " fps\n";
 236     }
 237
 238     if (wait) {
 239         while (ws->processEvents()) {}
 240     } else {
 241         exit(0);
 242     }
 243 }
 244
 245
 246 static void usage(void) {
 247     std::cout <<
 248         "Usage: glretrace [OPTION] TRACE\n"
 249         "Replay TRACE.\n"
 250         "\n"
 251         "  -b           benchmark mode (no error checking or warning messages)\n"
 252         "  -c PREFIX    compare against snapshots\n"
 253         "  -db          use a double buffer visual (default)\n"
 254         "  -sb          use a single buffer visual\n"
 255         "  -s PREFIX    take snapshots; `-` for PNM stdout output\n"
 256         "  -S FREQUENCY snapshot frequency: frame (default), framebuffer, or draw\n"
 257         "  -v           verbose output\n"
 258         "  -D CALLNO    dump state at specific call no\n"
 259         "  -w           wait on final frame\n";
 260 }
 261
 262 extern "C"
 263 int main(int argc, char **argv)
 264 {
 265
 266     int i;
 267     for (i = 1; i < argc; ++i) {
 268         const char *arg = argv[i];
 269
 270         if (arg[0] != '-') {
 271             break;
 272         }
 273
 274         if (!strcmp(arg, "--")) {
 275             break;
 276         } else if (!strcmp(arg, "-b")) {
 277             benchmark = true;
 278             retrace::verbosity = -1;
 279         } else if (!strcmp(arg, "-c")) {
 280             compare_prefix = argv[++i];
 281             if (snapshot_frequency == FREQUENCY_NEVER) {
 282                 snapshot_frequency = FREQUENCY_FRAME;
 283             }
 284         } else if (!strcmp(arg, "-D")) {
 285             dump_state = atoi(argv[++i]);
 286             retrace::verbosity = -2;
 287         } else if (!strcmp(arg, "-db")) {
 288             double_buffer = true;
 289         } else if (!strcmp(arg, "-sb")) {
 290             double_buffer = false;
 291         } else if (!strcmp(arg, "--help")) {
 292             usage();
 293             return 0;
 294         } else if (!strcmp(arg, "-s")) {
 295             snapshot_prefix = argv[++i];
 296             if (snapshot_frequency == FREQUENCY_NEVER) {
 297                 snapshot_frequency = FREQUENCY_FRAME;
 298             }
 299             if (snapshot_prefix[0] == '-' && snapshot_prefix[1] == 0) {
 300                 retrace::verbosity = -2;
 301             }
 302         } else if (!strcmp(arg, "-S")) {
 303             arg = argv[++i];
 304             if (!strcmp(arg, "frame")) {
 305                 snapshot_frequency = FREQUENCY_FRAME;
 306             } else if (!strcmp(arg, "framebuffer")) {
 307                 snapshot_frequency = FREQUENCY_FRAMEBUFFER;
 308             } else if (!strcmp(arg, "draw")) {
 309                 snapshot_frequency = FREQUENCY_DRAW;
 310             } else {
 311                 std::cerr << "error: unknown frequency " << arg << "\n";
 312                 usage();
 313                 return 1;
 314             }
 315             if (snapshot_prefix == NULL) {
 316                 snapshot_prefix = "";
 317             }
 318         } else if (!strcmp(arg, "-v")) {
 319             ++retrace::verbosity;
 320         } else if (!strcmp(arg, "-w")) {
 321             wait = true;
 322         } else {
 323             std::cerr << "error: unknown option " << arg << "\n";
 324             usage();
 325             return 1;
 326         }
 327     }
 328
 329     ws = glws::createNativeWindowSystem();
 330     visual = ws->createVisual(double_buffer);
 331
 332     for ( ; i < argc; ++i) {
 333         if (!parser.open(argv[i])) {
 334             std::cerr << "error: failed to open " << argv[i] << "\n";
 335             return 1;
 336         }
 337
 338         display();
 339
 340         parser.close();
 341     }
 342
 343     return 0;
 344 }
 345
 346 } /* namespace glretrace */