replace ramiros' windows help url with zeranoe's
[ffmpeg-web.git] / src / bugreports
1 <h1>Reporting a Bug To The FFmpeg Project</h1>
2
3 <p>
4 First of all, please remember that all the developers working on FFmpeg are
5 volunteers, we are not paid for analyzing, debugging, fixing and answering
6 bug reports. While we try our best to create high quality software and be
7 responsive, if you should not get an answer, please consider the above and
8 be aware of the fact that we receive many bug reports and the amount of
9 time it takes to deal with them can be substantial. Nevertheless most issues
10 get resolved, just please understand that there are no guarantees nor
11 promises.
12 </p>
13
14 <p>
15 <b>Before reporting a bug, please consider the following items</b>:
16 </p>
17
18 <p>
19 FFmpeg is in a state of perpetual development and we do not currently have the
20 person power to backport fixes to official releases. As such, if you wish to
21 query or report a bug, you must try with the <b>latest development branch</b> revision of
22 FFmpeg to confirm the issue still exists.
23 </p>
24
25 <p>
26 When writing your bug report, please include (uncompressed):
27 </p>
28 <ul>
29   <li>What you were trying to accomplish (e.g., "I am trying to transcode
30     from this format to that format...")</li>
31   <li>The problem you encountered (e.g., "<code>ffmpeg</code> crashed" or "The
32     output video was all green")</li>
33   <li>The exact command line you were using (e.g., "<code>ffmpeg -i input.mov
34     -an -vcodec foo output.avi</code>")</li>
35   <li>The full, uncut console output provided by
36     <code>ffmpeg -v 9 -loglevel 99 -i </code> followed by the name of your input file
37     (copy/pasted from the console, including the banner that indicates
38     version and configuration options), paste <code>ffplay</code> output
39     only if your problem is not reproducible with ffmpeg.</li>
40 </ul>
41
42 <p>
43 You can use the <code>-report</code> option or define the
44 <code>FFREPORT</code> environment variable (to any value) to get the exact
45 command line and the full verbose console output in a file named
46 <code>ffmpeg-*.log</code> in the current directory.
47 Note that the <code>-report</code> option is recent, it will not help
48 tracking regressions in old revisions.
49 </p>
50
51 <p>
52 If you encounter a crash bug, please provide the <code>gdb</code> output,
53 backtrace and disassembly using the the <code>ffmpeg_g</code> debug binary as
54 follows:
55 </p>
56
57 <blockquote>
58 <pre>gdb ffmpeg_g</pre>
59 </blockquote>
60
61 <p>
62 In <code>gdb</code>, type 'r' for run, along with the rest of the
63 <code>ffmpeg</code> command line:
64 </p>
65
66 <blockquote>
67 <pre>r &lt;rest of command line&gt;</pre>
68 </blockquote>
69
70 <p>
71 When <code>gdb</code> encounters its problem, run the following commands and
72 copy/paste the output into your bug report:
73 </p>
74
75 <blockquote>
76 <pre>
77 bt
78 disass $pc-32,$pc+32
79 info all-registers
80 </pre>
81 </blockquote>
82 <p>
83 With older <code>gdb</code> versions, use <code>disass $pc-32 $pc+32</code>.
84 </p>
85
86 <h2>Bug Tracker</h2>
87
88 <p>
89 Once you have gathered this information, you can submit a report to the
90 <a href="https://ffmpeg.org/trac/ffmpeg">FFmpeg bug tracker</a>.
91 Note, you must <a href="https://ffmpeg.org/trac/ffmpeg/register">register</a>
92 there first before you can submit a report.
93 You should provide all information so that anyone can reproduce the bug.
94 Please do not report your problem on the developer mailing list:
95 Only send bug reports there if you also intend to provide a fix.
96 </p>
97
98
99 <h2>Submitting Sample Media</h2>
100
101 <p>
102 The developers may ask you to provide a sample media file illustrating
103 your problem. In this case, please follow these steps:
104 </p>
105 <ul>
106   <li>If the sample file is too large ( &gt; 10 megabytes), cut it down to
107     size with the Unix 'dd' command:
108       <blockquote>
109       <pre>dd if=sample-file of=small-sample-file bs=1024 count=10000</pre>
110       </blockquote>
111     and then upload small-sample-file rather than sample-file</li>
112   <li>Please choose descriptive names like "h264_green_tint.mov" or
113       "block_artifacts_after_seeking.mkv". We already have plenty of "bug.rm"
114       and "sample.avi" to choose from.</li>
115   <li>Upload the sample to the MPlayer FTP server. Note that our FTP server
116     is write-only, as it would immediately get misused for warez trading
117     otherwise. Do not let this confuse you. Even though you cannot see the
118     stuff you upload, it will be there and the FFmpeg developers will have
119     access.
120   <ul>
121     <li>Log into upload.ffmpeg.org with an anonymous FTP login.</li>
122     <li>cd -> incoming</li>
123     <li>Upload a brief text file describing the sample and what is wrong.
124         <b>This is important!</b> If you leave out the text file, your
125         sample will most likely be deleted without further examination.</li>
126     <li>Upload the sample.</li>
127   </ul>
128   </li>
129   <li>Email the list and indicate the location of the sample.</li>
130 </ul>
131
132 <p>
133 <b>Important: Movie files which have been compressed (rar,7z,gzip,...) will be
134 deleted without being examined unless they are raw RGB/YUV/PCM.</b>
135 <b>Furthermore movie files uploaded to services like megaupload, rapidshare or
136 any other similar service will be ignored. We are not willing to spend our
137 time fighting with this ridiculous, bloated and spam-filled crap.</b>
138 </p>
139