git.cworth.org Git - apitrace/blob - TODO.markdown

   1 Things To Do
   2 ============
   3
   4 (in no particular order)
   5
   6
   7 Tracing
   8 -------
   9
  10 * Allow clamping to a GL version or a number of extensions.
  11
  12 * Trace multiple threads:
  13
  14   * `GetCurrentThreadId()`
  15
  16   * `pthread_self()`
  17
  18 * Put zlib (de)compression in a separate thread.
  19
  20 * Trace TSCs
  21
  22 * Trace window sizes somehow
  23
  24 * Allow to distinguish between the calls really done by the program, vs the
  25   fakes one necessary to retrace correctly.
  26
  27 * Start tracing on demand (e.g., key-press, or by frame no), emitting calls
  28   that recreate all current state.
  29
  30 * Add option to include call stack frames in the trace.
  31
  32 * Trace the internal GL calls done by GLU on Mac OS X & Windows.
  33
  34
  35 Retracing
  36 ---------
  37
  38 * Use visuals that best match those used in the trace; specially auto
  39   detect single/double buffer visuals.
  40
  41 * Respect multiple context sharing of the traces.
  42
  43 * Support multiple threads
  44
  45 * Leverage `ARB_debug_output` where available.
  46
  47 * D3D support.
  48
  49
  50 GUI
  51 ---
  52
  53 * Timeline view.
  54
  55 * Visualize meshes in draw commands.
  56
  57 * Breakpointing and step-by-step debugging.
  58
  59 CLI
  60 ---
  61
  62 * Add trace:      Generate a new trace by executing the given program
  63 * Add retrace     Replay all the calls in a trace
  64 * Add trim        Trim a trace by including only the specified calls/frames
  65 * Add dump-state  Output the OpenGL state in JSON format
  66 * Add dump-images Create image files for each frame/drawing operation of a trace
  67 * Add diff        Identify differences between a trace dump and another trace
  68 * Add diff-state  Identify differences between a state dump and another trace
  69 * Add diff-images Identify differences between images and another trace
  70
  71 * Add some common command-line options:
  72
  73   Most commands acting on a trace accept the following common options:
  74
  75    --calls=[RANGE]       Operate only on calls with index numbers within
  76                          the specified range.
  77
  78    --frames=[RANGE]      Operate only on frames with index numbers within
  79                          the specified range.
  80
  81    --functions=[REGEXP]  Operate only on function calls which have a
  82                          name that matches the given regular expression.
  83
  84    A [RANGE] can be any of the following:
  85
  86      Example    Description
  87      -------    -----------
  88      4          A single number specifying a single call or frame.
  89
  90      10-20      Two numbers separated by '-' (FIRST-LAST) specifying a
  91                 range of consecutive calls/frames from FIRST to LAST. If
  92                 either of FIRST or LAST is omitted, the first or last
  93                 call/frame index in the trace will be used.
  94
  95      1-100/5    Either of the above range specifications followed by '@'
  96                 and a number (INTERVAL). This specifies the inclusion of
  97                 only each INTERVAL call/frame within the range. For
  98                 example, 1-100@5 species frame 1, frame 5, frame 10,
  99                 ... up to frame 100.
 100
 101      4,10-20/2  A comma separated list of any of the above range
 102                 specifications, specifying the union of the ranges.
 103
 104 * Add some retrace-specific options (-b, -db, -sb, -v)
 105
 106 * Add some trime-specific options (--every={draw,framebuffer,frame})
 107
 108 * Accept a filename for --calls or --functions (to use the same calls
 109   or functions as present in a trace dump).
 110
 111 * Add an "apitrace bisect" for trimming down a trace based on user
 112   input at each stage.
 113
 114 * Add an "apitrace git-bisect-helper" for calling from git-bisect.
 115
 116
 117 Other
 118 -----
 119
 120 * Side-by-side trace diffing; either as a separate tool on or the GUI.
 121
 122 * Ability to extract just a single frame from a trace, and all previous calls
 123   that contributed to it:
 124
 125   * via a state tracker (i.e., knowledge of how calls affect the state);
 126
 127   * or by leveragine retrace, dumping the calls to emit all state at beginning
 128     of the frame.
 129
 130
 131 See also:
 132
 133 * open issues on [github](https://github.com/apitrace/apitrace/issues)
 134
 135 * _Known issues_ section in BUGS.markdown
 136
 137 * FIXME, TODO, and XXX comments on the source code.