1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
3
<title>Main Page</title>
4
<link href="doxygen.css" rel="stylesheet" type="text/css">
6
<!-- Generated by Doxygen 1.2.14 -->
8
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="modules.html">Modules</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </center>
9
<hr><h1>FLAC Documentation</h1>
11
<h3 align="center">1.1.0</h3> <a name="intro"><h2>Introduction</h2></a>
14
This is the documentation for the FLAC C and C++ APIs. It is highly interconnected; this introduction should give you a top level idea of the structure and how to find the information you need. As a prerequisite you should have at least a basic knowledge of the FLAC format, documented <a href="../format.html">here</a>.
16
<a name="c_api"><h2>FLAC C API</h2></a>
19
The FLAC C API is the interface to libFLAC, a set of structures describing the components of FLAC streams, and functions for encoding and decoding streams, as well as manipulating FLAC metadata in files. The public include files will be installed in your include area as <include>/FLAC/...
21
By writing a little code and linking against libFLAC, it is relatively easy to add FLAC support to another program. The library is licensed under the <a href="http://www.gnu.org/copyleft/lesser.html">LGPL</a>. Complete source code of libFLAC as well as the command-line encoder and plugins is available and is a useful source of examples.
23
Aside from encoders and decoders, libFLAC provides a powerful metadata interface for manipulating metadata in FLAC files. It allows the user to add, delete, and modify FLAC metadata blocks and it can automatically take advantage of PADDING blocks to avoid rewriting the entire FLAC file when changing the size of the metadata.
25
libFLAC usually only requires the standard C library and C math library. In particular, threading is not used so there is no dependency on a thread library. However, libFLAC does not use global variables and should be thread-safe.
27
There is also a new libOggFLAC library which wraps around libFLAC to provide routines for encoding to and decoding from FLAC streams inside an Ogg container. The interfaces are very similar or identical to their counterparts in libFLAC. libOggFLAC is also licensed under the LGPL.
29
<a name="cpp_api"><h2>FLAC C++ API</h2></a>
32
The FLAC C++ API is a set of classes that encapsulate the structures and functions in libFLAC. They provide slightly more functionality with respect to metadata but are otherwise equivalent. For the most part, they share the same usage as their counterparts in libFLAC, and the FLAC C API documentation can be used as a supplement. The public include files for the C++ API will be installed in your include area as <include>/FLAC++/...
34
There is also a new libOggFLAC++ library, which provides classes for encoding to and decoding from FLAC streams in an Ogg container. The classes are very similar to their counterparts in libFLAC++.
36
Both libFLAC++ libOggFLAC++ are also licensed under the <a href="http://www.gnu.org/copyleft/lesser.html">LGPL</a>.
38
<a name="getting_started"><h2>Getting Started</h2></a>
41
A good starting point for learning the API is to browse through the <a href="modules.html">modules</a>. Modules are logical groupings of related functions or classes, which correspond roughly to header files or sections of header files. Each module includes a detailed description of the general usage of its functions or classes.
43
From there you can go on to look at the documentation of individual functions. You can see different views of the individual functions through the links in top bar across this page.
45
<a name="embedded_developers"><h2>Embedded Developers</h2></a>
48
libFLAC has grown larger over time as more functionality has been included, but much of it may be unnecessary for a particular embedded implementation. Unused parts may be pruned by some simple editing of src/libFLAC/Makefile.am. In general, the decoders, encoders, and metadata interface are all independent from each other.
50
It is easiest to just describe the dependencies:
53
<li>All modules depend on the <a class="el" href="group__flac__format.html">Format</a> module.<li>The decoders and encoders are independent of each other.<li>The metadata interface requires the file decoder.<li>The decoder and encoder layers depend on the layers below them, but not above them; e.g. the seekable stream decoder depends on the stream decoder but not the file decoder</ul>
54
For example, if your application only requires the stream decoder, no encoders, and no metadata interface, you can remove the seekable stream decoder, file decoder, all encoders, and the metadata interface, which will greatly reduce the size of the library.
56
<hr><address><small>Generated on Sat Jan 25 10:44:45 2003 for FLAC by
57
<a href="http://www.doxygen.org/index.html">
58
<img src="doxygen.gif" alt="doxygen" align="middle" border=0
59
width=110 height=53></a>1.2.14 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>,
60
© 1997-2002</small></address>
added
removed
doc/html/api/index.html
