minor comments

This commit is contained in:
Josh Coalson
2006-11-04 03:03:02 +00:00
parent c5675fb8fc
commit 2dd9d916f6
2 changed files with 7 additions and 4 deletions

View File

@@ -490,7 +490,9 @@ typedef struct {
* \param client_data The callee's client data set through * \param client_data The callee's client data set through
* FLAC__stream_decoder_init_*(). * FLAC__stream_decoder_init_*().
* \retval FLAC__StreamDecoderReadStatus * \retval FLAC__StreamDecoderReadStatus
* The callee's return status. * The callee's return status. Note that the callback should return
* \c FLAC__STREAM_DECODER_READ_STATUS_END_OF_STREAM if and only if
* zero bytes were read and there is no more data to be read.
*/ */
typedef FLAC__StreamDecoderReadStatus (*FLAC__StreamDecoderReadCallback)(const FLAC__StreamDecoder *decoder, FLAC__byte buffer[], size_t *bytes, void *client_data); typedef FLAC__StreamDecoderReadStatus (*FLAC__StreamDecoderReadCallback)(const FLAC__StreamDecoder *decoder, FLAC__byte buffer[], size_t *bytes, void *client_data);

View File

@@ -2806,9 +2806,10 @@ FLAC__bool read_callback_(FLAC__byte buffer[], size_t *bytes, void *client_data)
} }
/* [1] @@@ HACK NOTE: The end-of-stream checking has to be hacked around /* [1] @@@ HACK NOTE: The end-of-stream checking has to be hacked around
* for Ogg FLAC. This is because the ogg decoder aspect can lose sync * for Ogg FLAC. This is because the ogg decoder aspect can lose sync
* and at the same time hit the end of the stream. There is no way to * and at the same time hit the end of the stream (for example, seeking
* report an Ogg sync loss through the callbacks (see note in * to a point that is after the beginning of the last Ogg page). There
* read_callback_ogg_aspect_()) so it returns CONTINUE with *bytes==0. * is no way to report an Ogg sync loss through the callbacks (see note
* in read_callback_ogg_aspect_()) so it returns CONTINUE with *bytes==0.
* So to keep the decoder from stopping at this point we gate the call * So to keep the decoder from stopping at this point we gate the call
* to the eof_callback and let the Ogg decoder aspect set the * to the eof_callback and let the Ogg decoder aspect set the
* end-of-stream state when it is needed. * end-of-stream state when it is needed.