| /* libFLAC - Free Lossless Audio Codec library |
| * Copyright (C) 2000,2001,2002 Josh Coalson |
| * |
| * This library is free software; you can redistribute it and/or |
| * modify it under the terms of the GNU Library General Public |
| * License as published by the Free Software Foundation; either |
| * version 2 of the License, or (at your option) any later version. |
| * |
| * This library is distributed in the hope that it will be useful, |
| * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| * Library General Public License for more details. |
| * |
| * You should have received a copy of the GNU Library General Public |
| * License along with this library; if not, write to the |
| * Free Software Foundation, Inc., 59 Temple Place - Suite 330, |
| * Boston, MA 02111-1307, USA. |
| */ |
| |
| #ifndef FLAC__ALL_H |
| #define FLAC__ALL_H |
| |
| #include "assert.h" |
| #include "file_decoder.h" |
| #include "format.h" |
| #include "metadata.h" |
| #include "ordinals.h" |
| #include "seekable_stream_decoder.h" |
| #include "stream_decoder.h" |
| #include "stream_encoder.h" |
| |
| /** \mainpage |
| * |
| * \section intro Introduction. |
| * |
| * 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 XXXhereXXX. |
| * |
| * 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/... |
| * |
| * 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++/... |
| * |
| * A good starting point for learning the API is to browse through |
| * the XXX modules XXX. 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. |
| * |
| * 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. |
| */ |
| |
| /** \defgroup flac FLAC C API |
| * |
| * 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. |
| * |
| * You should start with the XXX Format XXX module as all other modules |
| * are dependent on it. |
| */ |
| |
| #endif |