max the largest metadata type code be 126, reserving 127 to avoid confusion with...
[flac.git] / include / FLAC / all.h
1 /* libFLAC - Free Lossless Audio Codec library
2  * Copyright (C) 2000,2001,2002,2003,2004  Josh Coalson
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * - Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *
11  * - Redistributions in binary form must reproduce the above copyright
12  * notice, this list of conditions and the following disclaimer in the
13  * documentation and/or other materials provided with the distribution.
14  *
15  * - Neither the name of the Xiph.org Foundation nor the names of its
16  * contributors may be used to endorse or promote products derived from
17  * this software without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22  * A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
23  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
24  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
25  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
26  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
27  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
28  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
29  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31
32 #ifndef FLAC__ALL_H
33 #define FLAC__ALL_H
34
35 #include "export.h"
36
37 #include "assert.h"
38 #include "callback.h"
39 #include "file_decoder.h"
40 #include "file_encoder.h"
41 #include "format.h"
42 #include "metadata.h"
43 #include "ordinals.h"
44 #include "seekable_stream_decoder.h"
45 #include "seekable_stream_encoder.h"
46 #include "stream_decoder.h"
47 #include "stream_encoder.h"
48
49 /** \mainpage
50  *
51  * \section intro Introduction
52  *
53  * This is the documentation for the FLAC C and C++ APIs.  It is
54  * highly interconnected; this introduction should give you a top
55  * level idea of the structure and how to find the information you
56  * need.  As a prerequisite you should have at least a basic
57  * knowledge of the FLAC format, documented
58  * <A HREF="../format.html">here</A>.
59  *
60  * \section c_api FLAC C API
61  *
62  * The FLAC C API is the interface to libFLAC, a set of structures
63  * describing the components of FLAC streams, and functions for
64  * encoding and decoding streams, as well as manipulating FLAC
65  * metadata in files.  The public include files will be installed
66  * in your include area as <include>/FLAC/...
67  *
68  * By writing a little code and linking against libFLAC, it is
69  * relatively easy to add FLAC support to another program.  The
70  * library is licensed under the
71  * <A HREF="http://www.gnu.org/copyleft/lesser.html">LGPL</A>.
72  * Complete source code of libFLAC as well as the command-line
73  * encoder and plugins is available and is a useful source of
74  * examples.
75  *
76  * Aside from encoders and decoders, libFLAC provides a powerful
77  * metadata interface for manipulating metadata in FLAC files.  It
78  * allows the user to add, delete, and modify FLAC metadata blocks
79  * and it can automatically take advantage of PADDING blocks to avoid
80  * rewriting the entire FLAC file when changing the size of the
81  * metadata.
82  *
83  * libFLAC usually only requires the standard C library and C math
84  * library. In particular, threading is not used so there is no
85  * dependency on a thread library. However, libFLAC does not use
86  * global variables and should be thread-safe.
87  *
88  * There is also a new libOggFLAC library which wraps around libFLAC
89  * to provide routines for encoding to and decoding from FLAC streams
90  * inside an Ogg container.  The interfaces are very similar or identical
91  * to their counterparts in libFLAC.  libOggFLAC is also licensed under
92  * the LGPL.
93  *
94  * \section cpp_api FLAC C++ API
95  *
96  * The FLAC C++ API is a set of classes that encapsulate the
97  * structures and functions in libFLAC.  They provide slightly more
98  * functionality with respect to metadata but are otherwise
99  * equivalent.  For the most part, they share the same usage as
100  * their counterparts in libFLAC, and the FLAC C API documentation
101  * can be used as a supplement.  The public include files
102  * for the C++ API will be installed in your include area as
103  * <include>/FLAC++/...
104  *
105  * There is also a new libOggFLAC++ library, which provides classes
106  * for encoding to and decoding from FLAC streams in an Ogg container.
107  * The classes are very similar to their counterparts in libFLAC++.
108  *
109  * Both libFLAC++ libOggFLAC++ are also licensed under the
110  * <A HREF="http://www.gnu.org/copyleft/lesser.html">LGPL</A>.
111  *
112  * \section getting_started Getting Started
113  *
114  * A good starting point for learning the API is to browse through
115  * the <A HREF="modules.html">modules</A>.  Modules are logical
116  * groupings of related functions or classes, which correspond roughly
117  * to header files or sections of header files.  Each module includes a
118  * detailed description of the general usage of its functions or
119  * classes.
120  *
121  * From there you can go on to look at the documentation of
122  * individual functions.  You can see different views of the individual
123  * functions through the links in top bar across this page.
124  *
125  * \section embedded_developers Embedded Developers
126  *
127  * libFLAC has grown larger over time as more functionality has been
128  * included, but much of it may be unnecessary for a particular embedded
129  * implementation.  Unused parts may be pruned by some simple editing of
130  * src/libFLAC/Makefile.am.  In general, the decoders, encoders, and
131  * metadata interface are all independent from each other.
132  *
133  * It is easiest to just describe the dependencies:
134  *
135  * - All modules depend on the \link flac_format Format \endlink module.
136  * - The decoders and encoders are independent of each other.
137  * - The metadata interface requires the file decoder.
138  * - The decoder and encoder layers depend on the layers below them, but
139  *   not above them; e.g. the seekable stream decoder depends on the stream
140  *   decoder but not the file decoder
141  *
142  * For example, if your application only requires the stream decoder, no
143  * encoders, and no metadata interface, you can remove the seekable stream
144  * decoder, file decoder, all encoders, and the metadata interface, which
145  * will greatly reduce the size of the library.
146  */
147
148 /** \defgroup flac FLAC C API
149  *
150  * The FLAC C API is the interface to libFLAC, a set of structures
151  * describing the components of FLAC streams, and functions for
152  * encoding and decoding streams, as well as manipulating FLAC
153  * metadata in files.
154  *
155  * You should start with the format components as all other modules
156  * are dependent on it.
157  */
158
159 #endif