1 /* libFLAC - Free Lossless Audio Codec library
2 * Copyright (C) 2000,2001,2002 Josh Coalson
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Library General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Library General Public License for more details.
14 * You should have received a copy of the GNU Library General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
24 #include "file_decoder.h"
28 #include "seekable_stream_decoder.h"
29 #include "stream_decoder.h"
30 #include "stream_encoder.h"
34 * \section intro Introduction.
36 * This is the documentation for the FLAC C and C++ APIs. It is
37 * highly interconnected; this introduction should give you a top
38 * level idea of the structure and how to find the information you
39 * need. As a prerequisite you should have at least a basic
40 * knowledge of the FLAC format, documented
41 * <A HREF="../format.html">here</A>.
43 * The FLAC C API is the interface to libFLAC, a set of structures
44 * describing the components of FLAC streams, and functions for
45 * encoding and decoding streams, as well as manipulating FLAC
46 * metadata in files. The public include files will be installed
47 * in your include area as <include>/FLAC/...
49 * The FLAC C++ API is a set of classes that encapsulate the
50 * structures and functions in libFLAC. They provide slightly more
51 * functionality with respect to metadata but are otherwise
52 * equivalent. For the most part, they share the same usage as
53 * their counterparts in libFLAC, and the FLAC C API documentation
54 * can be used as a supplement. The public include files
55 * for the C++ API will be installed in your include area as
56 * <include>/FLAC++/...
58 * A good starting point for learning the API is to browse through
59 * the <A HREF="modules.html">modules</A>. Modules are logical
60 * groupings of related functions or classes, which correspond roughly
61 * to header files or sections of header files. Each module includes a
62 * detailed description of the general usage of its functions or
65 * From there you can go on to look at the documentation of
66 * individual functions. You can see different views of the individual
67 * functions through the links in top bar across this page.
70 /** \defgroup flac FLAC C API
72 * The FLAC C API is the interface to libFLAC, a set of structures
73 * describing the components of FLAC streams, and functions for
74 * encoding and decoding streams, as well as manipulating FLAC
77 * You should start with the format components as all other modules
78 * are dependent on it.