contact: Remove the Gmane link.
[ffmpeg-web.git] / src / bugreports
1 <p>
2   Before reporting a bug, please consider the following:<br>
3 </p>
4
5 <br>
6
7 <div class="info with-icon">
8   <span class="pull-right"><i class="fa fa-5x fa-check-square-o"></i></span>
9   FFmpeg is in a state of perpetual development.<br>
10   As such, if you wish to query or report a bug, you must try with the <b>latest development branch</b> revision of FFmpeg to confirm the issue still exists.
11 </div>
12
13 <br>
14
15 <div class="info with-icon">
16   <span class="pull-right"><i class="fa fa-5x fa-list-alt"></i></span>
17   When writing your bug report, please include (uncompressed):
18
19   <ul>
20     <li>What you were trying to accomplish (e.g., "I am trying to transcode
21       from this format to that format...")</li>
22     <li>The problem you encountered (e.g., "ffmpeg crashed, see the
23       gdb and valgrind output below" or "The
24       output video was all green")</li>
25     <li>The exact command line you were using (e.g., "<code>ffmpeg -i input.mov
26         -an -vcodec foo output.avi</code>")</li>
27     <li>The full, uncut console output provided by
28       <code>ffmpeg -v 9 -loglevel 99 -i </code> followed by the name of your input file
29       (copy/pasted from the console, including the banner that indicates
30       version and configuration options), paste ffplay or ffprobe output
31       only if your problem is not reproducible with ffmpeg.</li>
32     <li>Sufficient information, including any required input files, to reproduce
33       the bug and confirm a potential fix.</li>
34   </ul>
35 </div>
36
37 <br>
38
39 <div class="info with-icon">
40   <span class="pull-right"><i class="fa fa-5x fa-file-text-o"></i></span>
41   You can use the <code>-report</code> option or define the
42   <code>FFREPORT</code> environment variable (to any value) to get the exact
43   command line and the full verbose console output in a file named
44   <code>ffmpeg-*.log</code> in the current directory.<br>
45   Note that the <code>-report</code> option is recent, it will not help
46   tracking regressions in old revisions.
47 </div>
48
49 <br>
50
51 <div class="info with-icon">
52   <span class="pull-right"><i class="fa fa-5x fa-bug"></i></span>
53   If you encounter a crash bug, please provide the <code>gdb</code> output,
54   backtrace and disassembly, and if possible the <code>valgrind</code> output,
55   using the the <code>ffmpeg_g</code> debug binary.
56
57   <hr>
58
59   <p>
60     For <code>gdb</code>, proceed as follows:
61   </p>
62
63   <pre>gdb ffmpeg_g</pre>
64
65   <p>
66     In <code>gdb</code>, type 'r' for run, along with the rest of the
67     <code>ffmpeg</code> command line:
68   </p>
69
70   <pre>r &lt;rest of command line&gt;</pre>
71
72   <i>
73     Alternatively, you can run <code>gdb --args ffmpeg_g &lt;rest of command
74       line&gt;</code> and just type 'r' at the <code>gdb</code> prompt.
75   </i>
76
77   <p>
78     When <code>gdb</code> encounters its problem, run the following commands and
79     copy/paste the output into your bug report:
80   </p>
81
82   <pre>
83 bt
84 disass $pc-32,$pc+32
85 info all-registers</pre>
86   <p>
87     With older <code>gdb</code> versions, use <code>disass $pc-32 $pc+32</code>.
88   </p>
89
90   <hr>
91
92   <p>
93     For <code>valgrind</code>, run the following command and copy/paste the
94     output into your bug report:
95   </p>
96
97   <pre>valgrind ffmpeg_g &lt;rest of command line&gt;</pre>
98
99 </div>
100
101 <div class="info with-icon">
102   <span class="pull-right"><i class="fa fa-5x fa-bug"></i></span>
103   If you encounter a regression, please use <code>git bisect</code> to find the
104   revission that caused the regression. Having this information available can
105   greatly speed up correcting the bug.
106 </div>
107
108 <h3 id="BugTracker">
109   <span class="pull-right">
110     <i class="fa fa-bug"></i> &nbsp;
111   </span>
112   Bug Tracker</h3>
113
114 <p>
115   Once you have gathered this information, you can submit a report to the
116   <a href="https://trac.ffmpeg.org">FFmpeg bug tracker</a>.
117 </p>
118 <p>
119   <i>Note, you must <a href="https://trac.ffmpeg.org/register">register</a>
120     there first before you can submit a report.</i>
121 </p>
122 <p>
123   You should provide all information so that anyone can reproduce the bug.<br>
124   Please do not report your problem on the developer mailing list:<br>
125   Only send bug reports there if you also intend to provide a fix.
126 </p>
127
128 <h3 id="SubmittingSampleMedia">
129   <span class="pull-right">
130     <i class="fa fa-file-video-o"></i> &nbsp;
131   </span>
132   Submitting Sample Media</h3>
133
134 <p>
135   The developers may ask you to provide a sample media file illustrating
136   your problem. In this case, please follow these steps:
137 </p>
138 <ol>
139   <li>If the sample file is too large ( &gt; 10 megabytes), cut it down to
140     size with the Unix 'dd' command:<br><br>
141
142     <pre>dd if=sample-file of=small-sample-file bs=1024 count=10000</pre>
143     and then upload small-sample-file rather than sample-file<br><br></li>
144
145   <li>Please choose descriptive names like <code>h264_green_tint.mov</code> or
146     <code>block_artifacts_after_seeking.mkv</code>. We already have plenty of <code>bug.rm</code>
147     and <code>sample.avi</code>.<br><br></li>
148
149   <li>Upload the sample to the FTP server. Note that our FTP server
150     is write-only. Even though you cannot see the files that you upload,
151     it will be there and the FFmpeg developers will have access.<br><br>
152     <ul>
153       <li>Log into upload.ffmpeg.org with an anonymous FTP login.</li>
154       <li>cd -> incoming</li>
155       <li>Upload a brief text file describing the sample and what is wrong.
156         <b>This is important!</b> If you leave out the text file, your
157         sample will most likely be deleted without further examination.</li>
158       <li>Upload the sample.</li>
159     </ul>
160     <br><br></li>
161   <li>Email the ffmpeg mailing list and indicate the filename of the sample.<br><br></li>
162 </ol>
163
164 <p class="info with-icon">
165   <span class="pull-left"><i class="fa fa-5x fa-warning"></i></span>
166   Movie files which have been compressed (rar,7z,gzip,...) will be
167   deleted without being examined unless they are raw RGB/YUV/PCM.<br>
168   Furthermore movie files uploaded to services like rapidshare or
169   any other similar service will be ignored. We are not willing to spend our
170   time fighting with this ridiculous, bloated and spam-filled crap.
171 </p>