reorganize to be more novice-friendly, add more docs
[flac.git] / doc / html / developers.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <!-- Copyright (c) 2000,2001,2002,2003,2004,2005,2006  Josh Coalson -->
3 <!-- Permission is granted to copy, distribute and/or modify this document -->
4 <!-- under the terms of the GNU Free Documentation License, Version 1.1 -->
5 <!-- or any later version published by the Free Software Foundation; -->
6 <!-- with no invariant sections. -->
7 <!-- A copy of the license can be found at http://www.gnu.org/copyleft/fdl.html -->
8 <html>
9 <head>
10         <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
11         <meta name="author" content="Josh Coalson" />
12         <meta name="description" content="A free, open source codec for lossless audio compression and decompression" />
13         <meta name="keywords" content="free,lossless,audio,codec,encoder,decoder,compression,compressor,archival,archive,archiving,backup,music" />
14         <link rel="shortcut icon" type="image/x-icon" href="favicon.ico" />
15         <link rel="stylesheet" type="text/css" href="flac.css" />
16         <title>FLAC - developers</title>
17 </head>
18
19 <body>
20
21 <div class="logo">
22         <a href="http://flac.sourceforge.net/"><img src="images/logo130.gif" alt="FLAC Logo" align="middle" border="0" hspace="0" /></a>
23 </div>
24
25 <div class="above_nav"></div>
26
27 <div class="navbar">
28         &nbsp;<a href="index.html">home</a>&nbsp;&nbsp;|
29         &nbsp;<a href="faq.html">faq</a>&nbsp;&nbsp;|
30         &nbsp;<a href="news.html">news</a>&nbsp;&nbsp;|
31         &nbsp;<a href="download.html">download</a>&nbsp;&nbsp;|
32         &nbsp;<a href="documentation.html">documentation</a>&nbsp;&nbsp;|
33         &nbsp;<a href="comparison.html">comparison</a>&nbsp;&nbsp;|
34         &nbsp;<a href="changelog.html">changelog</a>&nbsp;&nbsp;|
35         &nbsp;<a href="links.html">links</a>&nbsp;&nbsp;|
36         &nbsp;developers&nbsp;
37 </div>
38
39 <div class="langbar">
40         &nbsp;english&nbsp;&nbsp;|
41         &nbsp;<a href="ru/developers.html">russian</a>&nbsp;
42 </div>
43
44 <div class="below_nav"></div>
45
46 <div class="box">
47         <div class="box_title">
48                 developers
49         </div>
50         <div class="box_header"></div>
51         <div class="box_body">
52                 FLAC is an open source project and we are happy to enlist the help of anyone who wants to contribute, or to help with FLAC support in other programs and devices.  The preferred method of communication is the <a href="http://lists.xiph.org/mailman/listinfo/flac-dev">developer mailing list</a>.<br />
53                 <br />
54                 FLAC is open to third-party developers who want to add support for FLAC into their programs.  All the necessary functionality is contained the libFLAC libraries which are licensed under <a href="license.html">Xiph.org's BSD license</a>.<br />
55                 <br />
56                 Some pointers to developer documentation and code:<br />
57                 <ul>
58                         <li><a href="license.html">License</a> - The license under which the official tools are distributed.</li>
59                         <li><a href="api/index.html">libFLAC and libFLAC++ APIs</a> - Complete library documentation.</li>
60                         <li><a href="format.html">FLAC Format Specification</a> - The formal specification.</li>
61                         <li><a href="ogg_mapping.html">Ogg FLAC Mapping</a> - How FLAC should be embedded in an Ogg container.</li>
62                         <li><a href="id.html">ID Registration</a> - Register an ID if you need to write custom metadata.</li>
63                         <li><a href="http://sourceforge.net/cvs/?group_id=13478">CVS Access</a> - instructions for checking out the source code.</li>
64                         <li><a href="http://flac.cvs.sourceforge.net/flac">Browse the CVS repository</a> from your web browser.</li>
65                 </ul>
66                 There also are several examples in the FLAC code base of API usage that may also be helpful.  Visit the <a href="download.html">download page</a> for instructions on how to get the source code.
67                 <br />
68                 Finally, more resources are available on the <a href="http://sourceforge.net/projects/flac">FLAC project page</a> on Sourceforge.net.
69         </div>
70         <div class="box_footer"></div>
71 </div>
72
73 <br />
74
75 <div class="box">
76         <div class="box_title">
77                 goals
78         </div>
79         <div class="box_header"></div>
80         <div class="box_body">
81                 Since FLAC is an open-source project, it's important to have a set of goals that everyone works to.  They may change slightly from time to time but they're a good guideline.  Changes should be in line with the goals and should not attempt to embrace any of the anti-goals.<br />
82                 <br />
83                 <b>Goals</b>
84                 <ul>
85                         <li>
86                                 FLAC should be and stay an open format with an open-source reference implementation.
87                         </li>
88                         <li>
89                                 FLAC should be lossless.  This seems obvious but lossy compression seems to creep into every audio codec.  This goal also means that <span class="commandname">flac</span> should stay archival quality and be truly lossless for all input.  Testing of releases should be thorough.
90                         </li>
91                         <li>
92                                 FLAC should yield respectable compression, on par or better than other lossless codecs.
93                         </li>
94                         <li>
95                                 FLAC should allow at least realtime decoding on even modest hardware.
96                         </li>
97                         <li>
98                                 FLAC should support fast sample-accurate seeking.
99                         </li>
100                         <li>
101                                 FLAC should allow gapless playback of consecutive streams.  This follows from the lossless goal.
102                         </li>
103                         <li>
104                                 The FLAC project owes a lot to the many people who have advanced the audio compression field so freely, and aims also to contribute through the open-source development of new ideas.
105                         </li>
106                 </ul>
107                 <b>Anti-goals</b><br />
108                 <ul>
109                         <li>
110                                 Lossy compression.  There are already many suitable lossy formats (<a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a>, <a href="http://www.mp3-tech.org/">MP3</a>, etc.).
111                         </li>
112                         <li>
113                                 Copy prevention, DRM, etc.  There is no intention to add any copy prevention methods.  Of course, we can't stop someone from encrypting a FLAC stream in another container (e.g. the way Apple encrypts AAC in MP4 with FairPlay), that is the choice of the user.
114                         </li>
115                 </ul>
116         </div>
117         <div class="box_footer"></div>
118 </div>
119
120
121 <div class="copyright">
122         <!-- @@@ oh so hacky -->
123         <table>
124                 <tr>
125                         <td align="left">
126                                 Copyright (c) 2000,2001,2002,2003,2004,2005,2006  Josh Coalson
127                         </td>
128                         <td width="1%" align="right">
129                                 <a href="http://sourceforge.net"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=13478&amp;type=1" width="88" height="31" border="0" alt="SourceForge.net Logo" /></a>
130                         </td>
131                         <td width="1%" align="right">
132                                 <a href="http://www.eff.org/cafe/"><img src="images/cafebug.gif" alt="CAFE Logo" border="0" /></a><br />
133                         </td>
134                         <td width="1%" align="right">
135                                 <a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" border="0" hspace="0" /></a>
136                         </td>
137                 </tr>
138         </table>
139 </div>
140
141 </body>
142 </html>