git.cworth.org Git - apitrace/blob - cli/cli_dump_images.cpp

   1 /*********************************************************************
   2  *
   3  * Copyright 2011 Jose Fonseca
   4  * Copyright 2012 Intel Corporation
   5  * All Rights Reserved.
   6  *
   7  * Permission is hereby granted, free of charge, to any person
   8  * obtaining a copy of this software and associated documentation
   9  * files (the "Software"), to deal in the Software without
  10  * restriction, including without limitation the rights to use, copy,
  11  * modify, merge, publish, distribute, sublicense, and/or sell copies
  12  * of the Software, and to permit persons to whom the Software is
  13  * furnished to do so, subject to the following conditions:
  14  *
  15  * The above copyright notice and this permission notice shall be
  16  * included in all copies or substantial portions of the Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  19  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  20  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  21  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  22  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  23  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  24  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  25  * SOFTWARE.
  26  *
  27  *********************************************************************/
  28
  29 #include <string.h>
  30 #include <limits.h> // for CHAR_MAX
  31 #include <getopt.h>
  32 #include <iostream>
  33
  34 #include "cli.hpp"
  35
  36 #include "os_string.hpp"
  37 #include "os_process.hpp"
  38
  39 static const char *synopsis = "Dump frame images obtained from a trace.";
  40
  41 static void
  42 usage(void)
  43 {
  44     std::cout << "usage apitrace dump-images [OPTIONS] TRACE_FILE\n"
  45               << synopsis << "\n"
  46         "\n"
  47         "    -h, --help           show this help message and exit\n"
  48         "        --calls=CALLSET  dump images only for specified calls\n"
  49         "                         (default value is \"*/frame\" which\n"
  50         "                          which dumps an image for each frame)\n"
  51         "    -o, --output=PREFIX  prefix to use in naming output files\n"
  52         "                         (default is trace filename without extension)\n"
  53         "\n";
  54 }
  55
  56 enum {
  57     CALLS_OPT = CHAR_MAX + 1,
  58 };
  59
  60 const static char *
  61 shortOptions = "ho:";
  62
  63 const static struct option
  64 longOptions[] = {
  65     {"help", no_argument, 0, 'h'},
  66     {"calls", required_argument, 0, CALLS_OPT},
  67     {"output", required_argument, 0, 'o'},
  68     {0, 0, 0, 0}
  69 };
  70
  71 static int
  72 command(int argc, char *argv[])
  73 {
  74     os::String prefix;
  75     const char *calls, *filename, *output = NULL;
  76
  77     int opt;
  78     while ((opt = getopt_long(argc, argv, shortOptions, longOptions, NULL)) != -1) {
  79         switch (opt) {
  80         case 'h':
  81             usage();
  82             return 0;
  83         case CALLS_OPT:
  84             calls = optarg;
  85             break;
  86         case 'o':
  87             output = optarg;
  88             break;
  89         default:
  90             std::cerr << "error: unexpected option `" << opt << "`\n";
  91             usage();
  92             return 1;
  93         }
  94     }
  95
  96     if (optind >= argc) {
  97         std::cerr << "error: apitrace dump-images requires a trace file as an argument.\n";
  98         usage();
  99         return 1;
 100     }
 101
 102     if (optind < argc - 1) {
 103         std::cerr << "error: apitrace dump-images can accept only a single trace file argument.\n";
 104         usage();
 105         return 1;
 106     }
 107
 108     filename = argv[optind];
 109
 110     if (output == NULL) {
 111         prefix = filename;
 112         prefix.trimDirectory();
 113         prefix.trimExtension();
 114         output = prefix.str();
 115     }
 116
 117     /* FIXME: It would be cleaner to pull the replaying of the trace
 118      * in-process here and generate the images directly. But that
 119      * pulls in a non-trivial amount of the existing 'retrace' code,
 120      * along with dependencies on GL, etc.
 121      *
 122      * It will definitely make sense to do that once all that code has
 123      * already been pulled in for the "apitrace retrace" (or "apitrace
 124      * replay") command. */
 125     std::vector<const char *> command;
 126     command.push_back("glretrace");
 127     command.push_back("-s");
 128     command.push_back(output);
 129     command.push_back("-S");
 130     if (calls)
 131         command.push_back(calls);
 132     else
 133         command.push_back("*/frame");
 134     command.push_back(filename);
 135     command.push_back(NULL);
 136
 137     return os::execute((char * const *)&command[0]);
 138 }
 139
 140 const Command dump_images_command = {
 141     "dump-images",
 142     synopsis,
 143     usage,
 144     command
 145 };