mirrors
/
flac
mirror of https://github.com/xiph/flac
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

comments

This commit is contained in:
Josh Coalson 2006-07-06 07:49:36 +00:00
parent 1a8afc7031
commit ba26e4e59e
2 changed files with 13 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
include/FLAC/stream_encoder.h
View File

@ -55,7 +55,7 @@ extern "C" {
* \ingroup flac * \ingroup flac
* *
* \brief * \brief
* This module describes the two encoder layers provided by libFLAC. * This module describes the three encoder layers provided by libFLAC.
* *
* For encoding FLAC streams, libFLAC provides three layers of access. The * For encoding FLAC streams, libFLAC provides three layers of access. The
* lowest layer is non-seekable stream-level encoding, the next is seekable * lowest layer is non-seekable stream-level encoding, the next is seekable

27
include/OggFLAC/stream_decoder.h
View File

@ -571,11 +571,10 @@ OggFLAC_API FLAC__bool OggFLAC__stream_decoder_reset(OggFLAC__StreamDecoder *dec
* \code decoder != NULL \endcode * \code decoder != NULL \endcode
* \code OggFLAC__stream_decoder_get_state(decoder) == OggFLAC__STREAM_DECODER_OK \endcode * \code OggFLAC__stream_decoder_get_state(decoder) == OggFLAC__STREAM_DECODER_OK \endcode
* \retval FLAC__bool * \retval FLAC__bool
* \c false if any read or write error occurred (except * \c false if any fatal read, write, or memory allocation error
* \c FLAC__STREAM_DECODER_ERROR_STATUS_LOST_SYNC), else \c true; * occurred (meaning decoding must stop), else \c true; for more
* in any case, check the decoder state with * information about the decoder, check the decoder state with
* OggFLAC__stream_decoder_get_state() to see what went wrong or to * OggFLAC__stream_decoder_get_state().
* check for lost synchronization (a sign of stream corruption).
*/ */
OggFLAC_API FLAC__bool OggFLAC__stream_decoder_process_single(OggFLAC__StreamDecoder *decoder); OggFLAC_API FLAC__bool OggFLAC__stream_decoder_process_single(OggFLAC__StreamDecoder *decoder);
@ -588,11 +587,10 @@ OggFLAC_API FLAC__bool OggFLAC__stream_decoder_process_single(OggFLAC__StreamDec
* \code decoder != NULL \endcode * \code decoder != NULL \endcode
* \code OggFLAC__stream_decoder_get_state(decoder) == OggFLAC__STREAM_DECODER_OK \endcode * \code OggFLAC__stream_decoder_get_state(decoder) == OggFLAC__STREAM_DECODER_OK \endcode
* \retval FLAC__bool * \retval FLAC__bool
* \c false if any read or write error occurred (except * \c false if any fatal read, write, or memory allocation error
* \c OggFLAC__STREAM_DECODER_ERROR_STATUS_LOST_SYNC), else \c true; * occurred (meaning decoding must stop), else \c true; for more
* in any case, check the decoder state with * information about the decoder, check the decoder state with
* OggFLAC__stream_decoder_get_state() to see what went wrong or to * OggFLAC__stream_decoder_get_state().
* check for lost synchronization (a sign of stream corruption).
*/ */
OggFLAC_API FLAC__bool OggFLAC__stream_decoder_process_until_end_of_metadata(OggFLAC__StreamDecoder *decoder); OggFLAC_API FLAC__bool OggFLAC__stream_decoder_process_until_end_of_metadata(OggFLAC__StreamDecoder *decoder);
@ -605,11 +603,10 @@ OggFLAC_API FLAC__bool OggFLAC__stream_decoder_process_until_end_of_metadata(Ogg
* \code decoder != NULL \endcode * \code decoder != NULL \endcode
* \code OggFLAC__stream_decoder_get_state(decoder) == OggFLAC__STREAM_DECODER_OK \endcode * \code OggFLAC__stream_decoder_get_state(decoder) == OggFLAC__STREAM_DECODER_OK \endcode
* \retval FLAC__bool * \retval FLAC__bool
* \c false if any read or write error occurred (except * \c false if any fatal read, write, or memory allocation error
* \c OggFLAC__STREAM_DECODER_ERROR_STATUS_LOST_SYNC), else \c true; * occurred (meaning decoding must stop), else \c true; for more
* in any case, check the decoder state with * information about the decoder, check the decoder state with
* OggFLAC__stream_decoder_get_state() to see what went wrong or to * OggFLAC__stream_decoder_get_state().
* check for lost synchronization (a sign of stream corruption).
*/ */
OggFLAC_API FLAC__bool OggFLAC__stream_decoder_process_until_end_of_stream(OggFLAC__StreamDecoder *decoder); OggFLAC_API FLAC__bool OggFLAC__stream_decoder_process_until_end_of_stream(OggFLAC__StreamDecoder *decoder);