add undocumented option to flac: --ignore-chunk-sizes
[flac.git] / 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
146 /** \defgroup porting Porting Guide for New Versions
147  *
148  * This module describes differences in the library interfaces from
149  * version to version.  It assists in the porting of code that uses
150  * the libraries to newer versions of FLAC.
151  *
152  * One simple facility for making porting easier that has been added
153  * in FLAC 1.1.3 is a set of \c #defines in \c export.h of each
154  * library's includes (e.g. \c include/FLAC/export.h).  The
155  * \c #defines mirror the libraries'
156  * <A HREF="http://www.gnu.org/software/libtool/manual.html#Libtool-versioning">libtool version numbers</A>,
157  * e.g. in libFLAC there are \c FLAC_API_VERSION_CURRENT,
158  * \c FLAC_API_VERSION_REVISION, and \c FLAC_API_VERSION_AGE.
159  * These can be used to support multiple versions of an API during the
160  * transition phase, e.g.
161  *
162  * \code
163  * #if !defined(FLAC_API_VERSION_CURRENT) || FLAC_API_VERSION_CURRENT <= 7
164  *   legacy code
165  * #else
166  *   new code
167  * #endif
168  * \endcode
169  *
170  * The the source will work for multiple versions and the legacy code can
171  * easily be removed when the transition is complete.
172  *
173  * Another available symbol is FLAC_API_SUPPORTS_OGG_FLAC (defined in
174  * include/FLAC/export.h), which can be used to determine whether or not
175  * the library has been compiled with support for Ogg FLAC.  This is
176  * simpler than trying to call an Ogg init function and catching the
177  * error.
178  */
179
180 /** \defgroup porting_1_1_2_to_1_1_3 Porting from FLAC 1.1.2 to 1.1.3
181  *  \ingroup porting
182  *
183  *  \brief
184  *  This module describes porting from FLAC 1.1.2 to FLAC 1.1.3.
185  *
186  * The main change between the APIs in 1.1.2 and 1.1.3 is that they have
187  * been simplified.  First, libOggFLAC has been merged into libFLAC and
188  * libOggFLAC++ has been merged into libFLAC++.  Second, both the three
189  * decoding layers and three encoding layers have been merged into a
190  * single stream decoder and stream encoder.  That is, the functionality
191  * of FLAC__SeekableStreamDecoder and FLAC__FileDecoder has been merged
192  * into FLAC__StreamDecoder, and FLAC__SeekableStreamEncoder and
193  * FLAC__FileEncoder into FLAC__StreamEncoder.  Only the
194  * FLAC__StreamDecoder and FLAC__StreamEncoder remain.  What this means
195  * is there is now a single API that can be used to encode or decode
196  * streams to/from native FLAC or Ogg FLAC and the single API can work
197  * on both seekable and non-seekable streams.
198  *
199  * Instead of creating an encoder or decoder of a certain layer, now the
200  * client will always create a FLAC__StreamEncoder or
201  * FLAC__StreamDecoder.  The old layers are now differentiated by the
202  * initialization function.  For example, for the decoder,
203  * FLAC__stream_decoder_init() has been replaced by
204  * FLAC__stream_decoder_init_stream().  This init function takes
205  * callbacks for the I/O, and the seeking callbacks are optional.  This
206  * allows the client to use the same object for seekable and
207  * non-seekable streams.  For decoding a FLAC file directly, the client
208  * can use FLAC__stream_decoder_init_file() and pass just a filename
209  * and fewer callbacks; most of the other callbacks are supplied
210  * internally.  For situations where fopen()ing by filename is not
211  * possible (e.g. Unicode filenames on Windows) the client can instead
212  * open the file itself and supply the FILE* to
213  * FLAC__stream_decoder_init_FILE().  The init functions now returns a
214  * FLAC__StreamDecoderInitStatus instead of FLAC__StreamDecoderState.
215  * Since the callbacks and client data are now passed to the init
216  * function, the FLAC__stream_decoder_set_*_callback() functions and
217  * FLAC__stream_decoder_set_client_data() are no longer needed.  The
218  * rest of the calls to the decoder are the same as before.
219  *
220  * There are counterpart init functions for Ogg FLAC, e.g.
221  * FLAC__stream_decoder_init_ogg_stream().  All the rest of the calls
222  * and callbacks are the same as for native FLAC.
223  *
224  * As an example, in FLAC 1.1.2 a seekable stream decoder would have
225  * been set up like so:
226  *
227  * \code
228  * FLAC__SeekableStreamDecoder *decoder = FLAC__seekable_stream_decoder_new();
229  * if(decoder == NULL) do_something;
230  * FLAC__seekable_stream_decoder_set_md5_checking(decoder, true);
231  * [... other settings ...]
232  * FLAC__seekable_stream_decoder_set_read_callback(decoder, my_read_callback);
233  * FLAC__seekable_stream_decoder_set_seek_callback(decoder, my_seek_callback);
234  * FLAC__seekable_stream_decoder_set_tell_callback(decoder, my_tell_callback);
235  * FLAC__seekable_stream_decoder_set_length_callback(decoder, my_length_callback);
236  * FLAC__seekable_stream_decoder_set_eof_callback(decoder, my_eof_callback);
237  * FLAC__seekable_stream_decoder_set_write_callback(decoder, my_write_callback);
238  * FLAC__seekable_stream_decoder_set_metadata_callback(decoder, my_metadata_callback);
239  * FLAC__seekable_stream_decoder_set_error_callback(decoder, my_error_callback);
240  * FLAC__seekable_stream_decoder_set_client_data(decoder, my_client_data);
241  * if(FLAC__seekable_stream_decoder_init(decoder) != FLAC__SEEKABLE_STREAM_DECODER_OK) do_something;
242  * \endcode
243  *
244  * In FLAC 1.1.3 it is like this:
245  *
246  * \code
247  * FLAC__StreamDecoder *decoder = FLAC__stream_decoder_new();
248  * if(decoder == NULL) do_something;
249  * FLAC__stream_decoder_set_md5_checking(decoder, true);
250  * [... other settings ...]
251  * if(FLAC__stream_decoder_init_stream(
252  *   decoder,
253  *   my_read_callback,
254  *   my_seek_callback,      // or NULL
255  *   my_tell_callback,      // or NULL
256  *   my_length_callback,    // or NULL
257  *   my_eof_callback,       // or NULL
258  *   my_write_callback,
259  *   my_metadata_callback,  // or NULL
260  *   my_error_callback,
261  *   my_client_data
262  * ) != FLAC__STREAM_DECODER_INIT_STATUS_OK) do_something;
263  * \endcode
264  *
265  * or you could do;
266  *
267  * \code
268  * [...]
269  * FILE *file = fopen("somefile.flac","rb");
270  * if(file == NULL) do_somthing;
271  * if(FLAC__stream_decoder_init_FILE(
272  *   decoder,
273  *   file,
274  *   my_write_callback,
275  *   my_metadata_callback,  // or NULL
276  *   my_error_callback,
277  *   my_client_data
278  * ) != FLAC__STREAM_DECODER_INIT_STATUS_OK) do_something;
279  * \endcode
280  *
281  * or just:
282  *
283  * \code
284  * [...]
285  * if(FLAC__stream_decoder_init_file(
286  *   decoder,
287  *   "somefile.flac",
288  *   my_write_callback,
289  *   my_metadata_callback,  // or NULL
290  *   my_error_callback,
291  *   my_client_data
292  * ) != FLAC__STREAM_DECODER_INIT_STATUS_OK) do_something;
293  * \endcode
294  *
295  * Another small change to the decoder is in how it handles unparseable
296  * streams.  Before, when the decoder found an unparseable stream
297  * (reserved for when the decoder encounters a stream from a future
298  * encoder that it can't parse), it changed the state to
299  * \c FLAC__STREAM_DECODER_UNPARSEABLE_STREAM.  Now the decoder instead
300  * drops sync and calls the error callback with a new error code
301  * \c FLAC__STREAM_DECODER_ERROR_STATUS_UNPARSEABLE_STREAM.  This is
302  * more robust.  If your error callback does not discriminate on the the
303  * error state, your code does not need to be changed.
304  *
305  * The encoder now has a new setting:
306  * FLAC__stream_encoder_set_apodization().  This is for setting the
307  * method used to window the data before LPC analysis.  You only need to
308  * add a call to this function if the default is not suitable.   There
309  * are also two new convenience functions that may be useful:
310  * FLAC__metadata_object_cuesheet_calculate_cddb_id() and
311  * FLAC__metadata_get_cuesheet().
312  *
313  * The \a bytes parameter to FLAC__StreamDecoderReadCallback,
314  * FLAC__StreamEncoderReadCallback, and FLAC__StreamEncoderWriteCallback
315  * is now \c size_t instead of \c unsigned.
316  */
317
318 /** \defgroup porting_1_1_3_to_1_1_4 Porting from FLAC 1.1.3 to 1.1.4
319  *  \ingroup porting
320  *
321  *  \brief
322  *  This module describes porting from FLAC 1.1.3 to FLAC 1.1.4.
323  *
324  * There were no changes to any of the interfaces from 1.1.3 to 1.1.4.
325  * There was a slight change in the implementation of
326  * FLAC__stream_encoder_set_metadata(); the function now makes a copy
327  * of the \a metadata array of pointers so the client no longer needs
328  * to maintain it after the call.  The objects themselves that are
329  * pointed to by the array are still not copied though and must be
330  * maintained until the call to FLAC__stream_encoder_finish().
331  */
332
333 /** \defgroup flac FLAC C API
334  *
335  * The FLAC C API is the interface to libFLAC, a set of structures
336  * describing the components of FLAC streams, and functions for
337  * encoding and decoding streams, as well as manipulating FLAC
338  * metadata in files.
339  *
340  * You should start with the format components as all other modules
341  * are dependent on it.
342  */
343
344 #endif