include/FLAC/all.h

   1 /* libFLAC - Free Lossless Audio Codec library
   2  * Copyright (C) 2000,2001,2002,2003,2004,2005,2006,2007  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 "format.h"
  40 #include "metadata.h"
  41 #include "ordinals.h"
  42 #include "stream_decoder.h"
  43 #include "stream_encoder.h"
  44
  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 (for example /usr/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  * libFLAC also supports encoding to and decoding from Ogg FLAC.
  84  * However the metadata editing interfaces currently have limited
  85  * read-only support for Ogg FLAC files.
  86  *
  87  * \section cpp_api FLAC C++ API
  88  *
  89  * The FLAC C++ API is a set of classes that encapsulate the
  90  * structures and functions in libFLAC.  They provide slightly more
  91  * functionality with respect to metadata but are otherwise
  92  * equivalent.  For the most part, they share the same usage as
  93  * their counterparts in libFLAC, and the FLAC C API documentation
  94  * can be used as a supplement.  The public include files
  95  * for the C++ API will be installed in your include area (for
  96  * example /usr/include/FLAC++/...).
  97  *
  98  * libFLAC++ is also licensed under
  99  * <A HREF="../license.html">Xiph's BSD license</A>.
 100  *
 101  * \section getting_started Getting Started
 102  *
 103  * A good starting point for learning the API is to browse through
 104  * the <A HREF="modules.html">modules</A>.  Modules are logical
 105  * groupings of related functions or classes, which correspond roughly
 106  * to header files or sections of header files.  Each module includes a
 107  * detailed description of the general usage of its functions or
 108  * classes.
 109  *
 110  * From there you can go on to look at the documentation of
 111  * individual functions.  You can see different views of the individual
 112  * functions through the links in top bar across this page.
 113  *
 114  * \section porting_guide Porting Guide
 115  *
 116  * Starting with FLAC 1.1.3 a \link porting Porting Guide \endlink
 117  * has been introduced which gives detailed instructions on how to
 118  * port your code to newer versions of FLAC.
 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 depend on the bitbuffer.
 132  * - The decoder is independent of the encoder.  The encoder uses the
 133  *   decoder because of the verify feature, but this can be removed if
 134  *   not needed.
 135  * - Parts of the metadata interface require the stream decoder (but not
 136  *   the encoder).
 137  * - Ogg support is selectable through the compile time macro
 138  *   \c FLAC__HAS_OGG.
 139  *
 140  * For example, if your application only requires the stream decoder, no
 141  * encoder, and no metadata interface, you can remove the stream encoder
 142  * and the metadata interface, which will greatly reduce the size of the
 143  * library.
 144  *
 145  * Also, there are several places in the libFLAC code with comments marked
 146  * with "OPT:" where a #define can be changed to enable code that might be
 147  * faster on a specific platform.  Experimenting with these can yield faster
 148  * binaries.
 149  */
 150
 151 /** \defgroup porting Porting Guide for New Versions
 152  *
 153  * This module describes differences in the library interfaces from
 154  * version to version.  It assists in the porting of code that uses
 155  * the libraries to newer versions of FLAC.
 156  *
 157  * One simple facility for making porting easier that has been added
 158  * in FLAC 1.1.3 is a set of \c #defines in \c export.h of each
 159  * library's includes (e.g. \c include/FLAC/export.h).  The
 160  * \c #defines mirror the libraries'
 161  * <A HREF="http://www.gnu.org/software/libtool/manual.html#Libtool-versioning">libtool version numbers</A>,
 162  * e.g. in libFLAC there are \c FLAC_API_VERSION_CURRENT,
 163  * \c FLAC_API_VERSION_REVISION, and \c FLAC_API_VERSION_AGE.
 164  * These can be used to support multiple versions of an API during the
 165  * transition phase, e.g.
 166  *
 167  * \code
 168  * #if !defined(FLAC_API_VERSION_CURRENT) || FLAC_API_VERSION_CURRENT <= 7
 169  *   legacy code
 170  * #else
 171  *   new code
 172  * #endif
 173  * \endcode
 174  *
 175  * The the source will work for multiple versions and the legacy code can
 176  * easily be removed when the transition is complete.
 177  *
 178  * Another available symbol is FLAC_API_SUPPORTS_OGG_FLAC (defined in
 179  * include/FLAC/export.h), which can be used to determine whether or not
 180  * the library has been compiled with support for Ogg FLAC.  This is
 181  * simpler than trying to call an Ogg init function and catching the
 182  * error.
 183  */
 184
 185 /** \defgroup porting_1_1_2_to_1_1_3 Porting from FLAC 1.1.2 to 1.1.3
 186  *  \ingroup porting
 187  *
 188  *  \brief
 189  *  This module describes porting from FLAC 1.1.2 to FLAC 1.1.3.
 190  *
 191  * The main change between the APIs in 1.1.2 and 1.1.3 is that they have
 192  * been simplified.  First, libOggFLAC has been merged into libFLAC and
 193  * libOggFLAC++ has been merged into libFLAC++.  Second, both the three
 194  * decoding layers and three encoding layers have been merged into a
 195  * single stream decoder and stream encoder.  That is, the functionality
 196  * of FLAC__SeekableStreamDecoder and FLAC__FileDecoder has been merged
 197  * into FLAC__StreamDecoder, and FLAC__SeekableStreamEncoder and
 198  * FLAC__FileEncoder into FLAC__StreamEncoder.  Only the
 199  * FLAC__StreamDecoder and FLAC__StreamEncoder remain.  What this means
 200  * is there is now a single API that can be used to encode or decode
 201  * streams to/from native FLAC or Ogg FLAC and the single API can work
 202  * on both seekable and non-seekable streams.
 203  *
 204  * Instead of creating an encoder or decoder of a certain layer, now the
 205  * client will always create a FLAC__StreamEncoder or
 206  * FLAC__StreamDecoder.  The old layers are now differentiated by the
 207  * initialization function.  For example, for the decoder,
 208  * FLAC__stream_decoder_init() has been replaced by
 209  * FLAC__stream_decoder_init_stream().  This init function takes
 210  * callbacks for the I/O, and the seeking callbacks are optional.  This
 211  * allows the client to use the same object for seekable and
 212  * non-seekable streams.  For decoding a FLAC file directly, the client
 213  * can use FLAC__stream_decoder_init_file() and pass just a filename
 214  * and fewer callbacks; most of the other callbacks are supplied
 215  * internally.  For situations where fopen()ing by filename is not
 216  * possible (e.g. Unicode filenames on Windows) the client can instead
 217  * open the file itself and supply the FILE* to
 218  * FLAC__stream_decoder_init_FILE().  The init functions now returns a
 219  * FLAC__StreamDecoderInitStatus instead of FLAC__StreamDecoderState.
 220  * Since the callbacks and client data are now passed to the init
 221  * function, the FLAC__stream_decoder_set_*_callback() functions and
 222  * FLAC__stream_decoder_set_client_data() are no longer needed.  The
 223  * rest of the calls to the decoder are the same as before.
 224  *
 225  * There are counterpart init functions for Ogg FLAC, e.g.
 226  * FLAC__stream_decoder_init_ogg_stream().  All the rest of the calls
 227  * and callbacks are the same as for native FLAC.
 228  *
 229  * As an example, in FLAC 1.1.2 a seekable stream decoder would have
 230  * been set up like so:
 231  *
 232  * \code
 233  * FLAC__SeekableStreamDecoder *decoder = FLAC__seekable_stream_decoder_new();
 234  * if(decoder == NULL) do_something;
 235  * FLAC__seekable_stream_decoder_set_md5_checking(decoder, true);
 236  * [... other settings ...]
 237  * FLAC__seekable_stream_decoder_set_read_callback(decoder, my_read_callback);
 238  * FLAC__seekable_stream_decoder_set_seek_callback(decoder, my_seek_callback);
 239  * FLAC__seekable_stream_decoder_set_tell_callback(decoder, my_tell_callback);
 240  * FLAC__seekable_stream_decoder_set_length_callback(decoder, my_length_callback);
 241  * FLAC__seekable_stream_decoder_set_eof_callback(decoder, my_eof_callback);
 242  * FLAC__seekable_stream_decoder_set_write_callback(decoder, my_write_callback);
 243  * FLAC__seekable_stream_decoder_set_metadata_callback(decoder, my_metadata_callback);
 244  * FLAC__seekable_stream_decoder_set_error_callback(decoder, my_error_callback);
 245  * FLAC__seekable_stream_decoder_set_client_data(decoder, my_client_data);
 246  * if(FLAC__seekable_stream_decoder_init(decoder) != FLAC__SEEKABLE_STREAM_DECODER_OK) do_something;
 247  * \endcode
 248  *
 249  * In FLAC 1.1.3 it is like this:
 250  *
 251  * \code
 252  * FLAC__StreamDecoder *decoder = FLAC__stream_decoder_new();
 253  * if(decoder == NULL) do_something;
 254  * FLAC__stream_decoder_set_md5_checking(decoder, true);
 255  * [... other settings ...]
 256  * if(FLAC__stream_decoder_init_stream(
 257  *   decoder,
 258  *   my_read_callback,
 259  *   my_seek_callback,      // or NULL
 260  *   my_tell_callback,      // or NULL
 261  *   my_length_callback,    // or NULL
 262  *   my_eof_callback,       // or NULL
 263  *   my_write_callback,
 264  *   my_metadata_callback,  // or NULL
 265  *   my_error_callback,
 266  *   my_client_data
 267  * ) != FLAC__STREAM_DECODER_INIT_STATUS_OK) do_something;
 268  * \endcode
 269  *
 270  * or you could do;
 271  *
 272  * \code
 273  * [...]
 274  * FILE *file = fopen("somefile.flac","rb");
 275  * if(file == NULL) do_somthing;
 276  * if(FLAC__stream_decoder_init_FILE(
 277  *   decoder,
 278  *   file,
 279  *   my_write_callback,
 280  *   my_metadata_callback,  // or NULL
 281  *   my_error_callback,
 282  *   my_client_data
 283  * ) != FLAC__STREAM_DECODER_INIT_STATUS_OK) do_something;
 284  * \endcode
 285  *
 286  * or just:
 287  *
 288  * \code
 289  * [...]
 290  * if(FLAC__stream_decoder_init_file(
 291  *   decoder,
 292  *   "somefile.flac",
 293  *   my_write_callback,
 294  *   my_metadata_callback,  // or NULL
 295  *   my_error_callback,
 296  *   my_client_data
 297  * ) != FLAC__STREAM_DECODER_INIT_STATUS_OK) do_something;
 298  * \endcode
 299  *
 300  * Another small change to the decoder is in how it handles unparseable
 301  * streams.  Before, when the decoder found an unparseable stream
 302  * (reserved for when the decoder encounters a stream from a future
 303  * encoder that it can't parse), it changed the state to
 304  * \c FLAC__STREAM_DECODER_UNPARSEABLE_STREAM.  Now the decoder instead
 305  * drops sync and calls the error callback with a new error code
 306  * \c FLAC__STREAM_DECODER_ERROR_STATUS_UNPARSEABLE_STREAM.  This is
 307  * more robust.  If your error callback does not discriminate on the the
 308  * error state, your code does not need to be changed.
 309  *
 310  * The encoder now has a new setting:
 311  * FLAC__stream_encoder_set_apodization().  This is for setting the
 312  * method used to window the data before LPC analysis.  You only need to
 313  * add a call to this function if the default is not suitable.   There
 314  * are also two new convenience functions that may be useful:
 315  * FLAC__metadata_object_cuesheet_calculate_cddb_id() and
 316  * FLAC__metadata_get_cuesheet().
 317  *
 318  * The \a bytes parameter to FLAC__StreamDecoderReadCallback,
 319  * FLAC__StreamEncoderReadCallback, and FLAC__StreamEncoderWriteCallback
 320  * is now \c size_t instead of \c unsigned.
 321  */
 322
 323 /** \defgroup porting_1_1_3_to_1_1_4 Porting from FLAC 1.1.3 to 1.1.4
 324  *  \ingroup porting
 325  *
 326  *  \brief
 327  *  This module describes porting from FLAC 1.1.3 to FLAC 1.1.4.
 328  *
 329  * There were no changes to any of the interfaces from 1.1.3 to 1.1.4.
 330  * There was a slight change in the implementation of
 331  * FLAC__stream_encoder_set_metadata(); the function now makes a copy
 332  * of the \a metadata array of pointers so the client no longer needs
 333  * to maintain it after the call.  The objects themselves that are
 334  * pointed to by the array are still not copied though and must be
 335  * maintained until the call to FLAC__stream_encoder_finish().
 336  */
 337
 338 /** \defgroup porting_1_1_4_to_1_2_0 Porting from FLAC 1.1.4 to 1.2.0
 339  *  \ingroup porting
 340  *
 341  *  \brief
 342  *  This module describes porting from FLAC 1.1.4 to FLAC 1.2.0.
 343  *
 344  * There were only very minor changes to the interfaces from 1.1.4 to 1.2.0.
 345  * In libFLAC, \c FLAC__format_sample_rate_is_subset() was added.
 346  * In libFLAC++, \c FLAC::Decoder::Stream::get_decode_position() was added.
 347  *
 348  * Finally, value of the constant \c FLAC__FRAME_HEADER_RESERVED_LEN
 349  * has changed to reflect the conversion of one of the reserved bits
 350  * into active use.  It used to be \c 2 and now is \c 1.  However the
 351  * FLAC frame header length has not changed, so to skip the proper
 352  * number of bits, use \c FLAC__FRAME_HEADER_RESERVED_LEN +
 353  * \c FLAC__FRAME_HEADER_BLOCKING_STRATEGY_LEN
 354  */
 355
 356 /** \defgroup flac FLAC C API
 357  *
 358  * The FLAC C API is the interface to libFLAC, a set of structures
 359  * describing the components of FLAC streams, and functions for
 360  * encoding and decoding streams, as well as manipulating FLAC
 361  * metadata in files.
 362  *
 363  * You should start with the format components as all other modules
 364  * are dependent on it.
 365  */
 366
 367 #endif