|
cannam@125
|
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
|
cannam@125
|
2 <HTML>
|
|
cannam@125
|
3
|
|
cannam@125
|
4 <HEAD>
|
|
cannam@125
|
5 <TITLE>
|
|
cannam@125
|
6 Bug Reporting
|
|
cannam@125
|
7 </TITLE>
|
|
cannam@125
|
8 <META NAME="Author" CONTENT="Erik de Castro Lopo (erikd AT mega-nerd DOT com)">
|
|
cannam@125
|
9 <LINK REL="stylesheet" HREF="libsndfile.css" TYPE="text/css" MEDIA="all">
|
|
cannam@125
|
10 <LINK REL="stylesheet" HREF="print.css" TYPE="text/css" MEDIA="print">
|
|
cannam@125
|
11 </HEAD>
|
|
cannam@125
|
12
|
|
cannam@125
|
13 <BODY>
|
|
cannam@125
|
14
|
|
cannam@125
|
15 <CENTER>
|
|
cannam@125
|
16 <H1><B>Reporting Bugs in libsndfile</B></H1>
|
|
cannam@125
|
17 </CENTER>
|
|
cannam@125
|
18 <P>
|
|
cannam@125
|
19 Before even attempting to report a bug in libsndfile please make sure you have
|
|
cannam@125
|
20 read the
|
|
cannam@125
|
21 <A HREF="FAQ.html">Frequently Asked Questions</A>.
|
|
cannam@125
|
22 If you are having a problem writing code using libsndfile make sure you read
|
|
cannam@125
|
23 the
|
|
cannam@125
|
24 <A HREF="api.html">Application Programming Interface</A>
|
|
cannam@125
|
25 documentation.
|
|
cannam@125
|
26 </P>
|
|
cannam@125
|
27 <P>
|
|
cannam@125
|
28 That said, I am interested in finding and fixing all genuine bugs in libsndfile.
|
|
cannam@125
|
29 Bugs I want to fix include any of the following problems (and probably others) :
|
|
cannam@125
|
30 </P>
|
|
cannam@125
|
31 <UL>
|
|
cannam@125
|
32 <LI> Compilation problems on new platforms.
|
|
cannam@125
|
33 <LI> Errors being detected during the `make check' process.
|
|
cannam@125
|
34 <LI> Segmentation faults occuring inside libsndfile.
|
|
cannam@125
|
35 <LI> libsndfile hanging when opening a file.
|
|
cannam@125
|
36 <LI> Supported sound file types being incorrectly read or written.
|
|
cannam@125
|
37 <LI> Omissions, errors or spelling mistakes in the documentation.
|
|
cannam@125
|
38 </UL>
|
|
cannam@125
|
39
|
|
cannam@125
|
40 <P>
|
|
cannam@125
|
41 When submitting a bug report you must include :
|
|
cannam@125
|
42 </P>
|
|
cannam@125
|
43 <UL>
|
|
cannam@125
|
44 <LI> Your system (CPU and memory size should be enough).
|
|
cannam@125
|
45 <LI> The operating system you are using.
|
|
cannam@125
|
46 <LI> Whether you are using a package provided by your distribution or you
|
|
cannam@125
|
47 compiled it youself.
|
|
cannam@125
|
48 <LI> If you compiled it yourself, the compiler you are using. (Also make
|
|
cannam@125
|
49 sure to run 'make check'.)
|
|
cannam@125
|
50 <LI> A description of the problem.
|
|
cannam@125
|
51 <LI> Information generated by the sndfile-info program (see next paragraph).
|
|
cannam@125
|
52 <LI> If you are having problems with sndfile-play and ALSA on Linux, I will
|
|
cannam@125
|
53 need information about your kernel, ALSA version, compiler version,
|
|
cannam@125
|
54 whether you compiled the kernel/ALSA your self or installed from a
|
|
cannam@125
|
55 package etc.
|
|
cannam@125
|
56 </UL>
|
|
cannam@125
|
57
|
|
cannam@125
|
58 <P>
|
|
cannam@125
|
59 If libsndfile compiles and installs correctly but has difficulty reading a particular
|
|
cannam@125
|
60 file or type of file you should run the <B>sndfile-info</B> program (from the examples
|
|
cannam@125
|
61 directory of the libsndfile distribution) on the file. See
|
|
cannam@125
|
62 <A HREF="sndfile_info.html">here</A>
|
|
cannam@125
|
63 for an example of the use of the <B>sndfile-info</B> program.
|
|
cannam@125
|
64 </P>
|
|
cannam@125
|
65 <P>
|
|
cannam@125
|
66 Please do not send me a sound file which fails to open under libsndfile unless I
|
|
cannam@125
|
67 specifically ask you to. The above information should usually suffice for most
|
|
cannam@125
|
68 problems.
|
|
cannam@125
|
69 </P>
|
|
cannam@125
|
70 <P>
|
|
cannam@125
|
71 Once you have the above information you should submit a ticket on the libsnfile
|
|
cannam@125
|
72 <A HREF="https://github.com/erikd/libsndfile/issues">github issue tracker</A>.
|
|
cannam@125
|
73
|
|
cannam@125
|
74 </P>
|
|
cannam@125
|
75 </BODY>
|
|
cannam@125
|
76 </HTML>
|
