]> git.cworth.org Git - apitrace/blob - TODO.markdown
TODO: Fix typo in the description of the range specification.
[apitrace] / 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 retrace     Replay all the calls in a trace
63 * Add trim        Trim a trace by including only the specified calls/frames
64 * Add dump-state  Output the OpenGL state in JSON format
65 * Add dump-images Create image files for each frame/drawing operation of a trace
66 * Add diff-images Identify differences between images and another trace
67
68 * Add some common command-line options:
69
70   Most commands acting on a trace accept the following common options:
71
72    --calls=[RANGE]       Operate only on calls with index numbers within
73                          the specified range.
74
75    --frames=[RANGE]      Operate only on frames with index numbers within
76                          the specified range.
77
78    --functions=[REGEXP]  Operate only on function calls which have a
79                          name that matches the given regular expression.
80
81    A [RANGE] can be any of the following:
82
83      Example    Description        
84      -------    -----------        
85      4          A single number specifying a single call or frame.
86
87      10-20      Two numbers separated by '-' (FIRST-LAST) specifying a
88                 range of consecutive calls/frames from FIRST to LAST. If
89                 either of FIRST or LAST is omitted, the first or last
90                 call/frame index in the trace will be used.
91
92      1-100/5    Either of the above range specifications followed by '/'
93                 and a number (INTERVAL). This specifies the inclusion of
94                 only each INTERVAL call/frame within the range. For
95                 example, 1-100/5 species frame 1, frame 5, frame 10,
96                 ... up to frame 100.
97
98      4,10-20/2  A comma separated list of any of the above range
99                 specifications, specifying the union of the ranges.
100
101 * Add some retrace-specific options (-b, -db, -sb, -v)
102
103 * Add some trime-specific options (--every={draw,framebuffer,frame})
104
105 * Accept a filename for --calls or --functions (to use the same calls
106   or functions as present in a trace dump).
107
108 * Add an "apitrace bisect" for trimming down a trace based on user
109   input at each stage.
110
111 * Add an "apitrace git-bisect-helper" for calling from git-bisect.
112
113
114 Other
115 -----
116
117 * Side-by-side trace diffing; either as a separate tool on or the GUI.
118
119 * Ability to extract just a single frame from a trace, and all previous calls
120   that contributed to it:
121
122   * via a state tracker (i.e., knowledge of how calls affect the state);
123
124   * or by leveragine retrace, dumping the calls to emit all state at beginning
125     of the frame.
126
127
128 See also:
129
130 * open issues on [github](https://github.com/apitrace/apitrace/issues)
131
132 * _Known issues_ section in BUGS.markdown
133
134 * FIXME, TODO, and XXX comments on the source code.