all.h
上传用户:wstnjxml
上传日期:2014-04-03
资源大小:7248k
文件大小:7k
源码类别:

Windows CE

开发平台:

C/C++

  1. /* libFLAC - Free Lossless Audio Codec library
  2.  * Copyright (C) 2000,2001,2002,2003,2004,2005  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. #ifndef FLAC__ALL_H
  32. #define FLAC__ALL_H
  33. #include "export.h"
  34. #include "assert.h"
  35. #include "callback.h"
  36. #include "file_decoder.h"
  37. #include "file_encoder.h"
  38. #include "format.h"
  39. #include "metadata.h"
  40. #include "ordinals.h"
  41. #include "seekable_stream_decoder.h"
  42. #include "seekable_stream_encoder.h"
  43. #include "stream_decoder.h"
  44. #include "stream_encoder.h"
  45. /** mainpage
  46.  *
  47.  * section intro Introduction
  48.  *
  49.  * This is the documentation for the FLAC C and C++ APIs.  It is
  50.  * highly interconnected; this introduction should give you a top
  51.  * level idea of the structure and how to find the information you
  52.  * need.  As a prerequisite you should have at least a basic
  53.  * knowledge of the FLAC format, documented
  54.  * <A HREF="../format.html">here</A>.
  55.  *
  56.  * section c_api FLAC C API
  57.  *
  58.  * The FLAC C API is the interface to libFLAC, a set of structures
  59.  * describing the components of FLAC streams, and functions for
  60.  * encoding and decoding streams, as well as manipulating FLAC
  61.  * metadata in files.  The public include files will be installed
  62.  * in your include area as <include>/FLAC/...
  63.  *
  64.  * By writing a little code and linking against libFLAC, it is
  65.  * relatively easy to add FLAC support to another program.  The
  66.  * library is licensed under <A HREF="../license.html">Xiph's BSD license</A>.
  67.  * Complete source code of libFLAC as well as the command-line
  68.  * encoder and plugins is available and is a useful source of
  69.  * examples.
  70.  *
  71.  * Aside from encoders and decoders, libFLAC provides a powerful
  72.  * metadata interface for manipulating metadata in FLAC files.  It
  73.  * allows the user to add, delete, and modify FLAC metadata blocks
  74.  * and it can automatically take advantage of PADDING blocks to avoid
  75.  * rewriting the entire FLAC file when changing the size of the
  76.  * metadata.
  77.  *
  78.  * libFLAC usually only requires the standard C library and C math
  79.  * library. In particular, threading is not used so there is no
  80.  * dependency on a thread library. However, libFLAC does not use
  81.  * global variables and should be thread-safe.
  82.  *
  83.  * There is also a new libOggFLAC library which wraps around libFLAC
  84.  * to provide routines for encoding to and decoding from FLAC streams
  85.  * inside an Ogg container.  The interfaces are very similar or identical
  86.  * to their counterparts in libFLAC.  libOggFLAC is also licensed under
  87.  * <A HREF="../license.html">Xiph's BSD license</A>.
  88.  *
  89.  * section cpp_api FLAC C++ API
  90.  *
  91.  * The FLAC C++ API is a set of classes that encapsulate the
  92.  * structures and functions in libFLAC.  They provide slightly more
  93.  * functionality with respect to metadata but are otherwise
  94.  * equivalent.  For the most part, they share the same usage as
  95.  * their counterparts in libFLAC, and the FLAC C API documentation
  96.  * can be used as a supplement.  The public include files
  97.  * for the C++ API will be installed in your include area as
  98.  * <include>/FLAC++/...
  99.  *
  100.  * There is also a new libOggFLAC++ library, which provides classes
  101.  * for encoding to and decoding from FLAC streams in an Ogg container.
  102.  * The classes are very similar to their counterparts in libFLAC++.
  103.  *
  104.  * Both libFLAC++ libOggFLAC++ are also licensed under
  105.  * <A HREF="../license.html">Xiph's BSD license</A>.
  106.  *
  107.  * section getting_started Getting Started
  108.  *
  109.  * A good starting point for learning the API is to browse through
  110.  * the <A HREF="modules.html">modules</A>.  Modules are logical
  111.  * groupings of related functions or classes, which correspond roughly
  112.  * to header files or sections of header files.  Each module includes a
  113.  * detailed description of the general usage of its functions or
  114.  * classes.
  115.  *
  116.  * From there you can go on to look at the documentation of
  117.  * individual functions.  You can see different views of the individual
  118.  * functions through the links in top bar across this page.
  119.  *
  120.  * section embedded_developers Embedded Developers
  121.  *
  122.  * libFLAC has grown larger over time as more functionality has been
  123.  * included, but much of it may be unnecessary for a particular embedded
  124.  * implementation.  Unused parts may be pruned by some simple editing of
  125.  * src/libFLAC/Makefile.am.  In general, the decoders, encoders, and
  126.  * metadata interface are all independent from each other.
  127.  *
  128.  * It is easiest to just describe the dependencies:
  129.  *
  130.  * - All modules depend on the link flac_format Format endlink module.
  131.  * - The decoders and encoders are independent of each other.
  132.  * - The metadata interface requires the file decoder.
  133.  * - The decoder and encoder layers depend on the layers below them, but
  134.  *   not above them; e.g. the seekable stream decoder depends on the stream
  135.  *   decoder but not the file decoder
  136.  *
  137.  * For example, if your application only requires the stream decoder, no
  138.  * encoders, and no metadata interface, you can remove the seekable stream
  139.  * decoder, file decoder, all encoders, and the metadata interface, which
  140.  * will greatly reduce the size of the library.
  141.  */
  142. /** defgroup flac FLAC C API
  143.  *
  144.  * The FLAC C API is the interface to libFLAC, a set of structures
  145.  * describing the components of FLAC streams, and functions for
  146.  * encoding and decoding streams, as well as manipulating FLAC
  147.  * metadata in files.
  148.  *
  149.  * You should start with the format components as all other modules
  150.  * are dependent on it.
  151.  */
  152. #endif