2b1bdc482e0fc8f21d22a3e01d427e193be6fd36
[flac.git] / include / FLAC / all.h
1 /* libFLAC - Free Lossless Audio Codec library
2  * Copyright (C) 2000,2001,2002  Josh Coalson
3  *
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.
8  *
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.
13  *
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.
18  */
19
20 #ifndef FLAC__ALL_H
21 #define FLAC__ALL_H
22
23 #include "assert.h"
24 #include "file_decoder.h"
25 #include "format.h"
26 #include "metadata.h"
27 #include "ordinals.h"
28 #include "seekable_stream_decoder.h"
29 #include "stream_decoder.h"
30 #include "stream_encoder.h"
31
32 /** \mainpage
33  *
34  * \section intro Introduction.
35  *
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 XXXhereXXX.
41  *
42  * The FLAC C API is the interface to libFLAC, a set of structures
43  * describing the components of FLAC streams, and functions for
44  * encoding and decoding streams, as well as manipulating FLAC
45  * metadata in files.  The public include files will be installed
46  * in your include area as <include>/FLAC/...
47  *
48  * The FLAC C++ API is a set of classes that encapsulate the
49  * structures and functions in libFLAC.  They provide slightly more
50  * functionality with respect to metadata but are otherwise
51  * equivalent.  For the most part, they share the same usage as
52  * their counterparts in libFLAC, and the FLAC C API documentation
53  * can be used as a supplement.  The public include files
54  * for the C++ API will be installed in your include area as
55  * <include>/FLAC++/...
56  *
57  * A good starting point for learning the API is to browse through
58  * the XXX modules XXX.  Modules are logical groupings of related
59  * functions or classes, which correspond roughly to header files
60  * or sections of header files.  Each module includes a detailed
61  * description of the general usage of its functions or classes.
62  *
63  * From there you can go on to look at the documentation of
64  * individual functions.  You can see different views of the individual
65  * functions through the links in top bar across this page.
66  */
67
68 /** \defgroup flac FLAC C API
69  *
70  * The FLAC C API is the interface to libFLAC, a set of structures
71  * describing the components of FLAC streams, and functions for
72  * encoding and decoding streams, as well as manipulating FLAC
73  * metadata in files.
74  *
75  * You should start with the XXX Format XXX module as all other modules
76  * are dependent on it.
77  */
78
79 #endif