From 8d06d47f95ae308fb23db600e1b4ba20fd411c98 Mon Sep 17 00:00:00 2001 From: Josh Coalson Date: Tue, 23 Sep 2003 20:28:05 +0000 Subject: [PATCH] minor comments --- include/OggFLAC/stream_decoder.h | 28 ++++++++++++++++++++-------- src/libOggFLAC/stream_encoder.c | 2 +- 2 files changed, 21 insertions(+), 9 deletions(-) diff --git a/include/OggFLAC/stream_decoder.h b/include/OggFLAC/stream_decoder.h index d2f9886..f3e5a83 100644 --- a/include/OggFLAC/stream_decoder.h +++ b/include/OggFLAC/stream_decoder.h @@ -55,11 +55,11 @@ extern "C" { * \ingroup oggflac * * \brief - * This module describes the decoder layers provided by libOggFLAC. + * This module describes the three decoder layers provided by libOggFLAC. * - * libOggFLAC currently provides the same stream layer access as libFLAC; - * the interface is identical. See the \link flac_decoder FLAC - * decoder module \endlink for full documentation. + * libOggFLAC currently provides the same three layers of access as + * libFLAC; the interface is identical. See the \link flac_decoder + * FLAC decoder module \endlink for full documentation. */ /** \defgroup oggflac_stream_decoder OggFLAC/stream_decoder.h: stream decoder interface @@ -70,8 +70,10 @@ extern "C" { * decoder. * * The interface here is identical to FLAC's stream decoder, - * including the callbacks. See the \link flac_stream_decoder - * FLAC stream decoder module \endlink for full documentation. + * including the callbacks, with the addition of + * OggFLAC__stream_decoder_set_serial_number(). See the + * \link flac_stream_decoder FLAC stream decoder module \endlink + * for full documentation. * * \{ */ @@ -146,7 +148,11 @@ typedef struct { * \param decoder The decoder instance calling the callback. * \param buffer A pointer to a location for the callee to store * data to be decoded. - * \param bytes A pointer to the size of the buffer. + * \param bytes A pointer to the size of the buffer. On entry + * to the callback, it contains the maximum number + * of bytes that may be stored in \a buffer. The + * callee must set it to the actual number of bytes + * stored before returning. * \param client_data The callee's client data set through * OggFLAC__stream_decoder_set_client_data(). * \retval FLAC__StreamDecoderReadStatus @@ -159,8 +165,14 @@ typedef FLAC__StreamDecoderReadStatus (*OggFLAC__StreamDecoderReadCallback)(cons * and FLAC__StreamDecoderWriteCallback for more info. * * \param decoder The decoder instance calling the callback. - * \param frame The description of the decoded frame. + * \param frame The description of the decoded frame. See + * FLAC__Frame. * \param buffer An array of pointers to decoded channels of data. + * Each pointer will point to an array of signed + * samples of length \a frame->header.blocksize. + * Currently, the channel order has no meaning + * except for stereo streams; in this case channel + * 0 is left and 1 is right. * \param client_data The callee's client data set through * OggFLAC__stream_decoder_set_client_data(). * \retval FLAC__StreamDecoderWriteStatus diff --git a/src/libOggFLAC/stream_encoder.c b/src/libOggFLAC/stream_encoder.c index 9f25b56..67544b4 100644 --- a/src/libOggFLAC/stream_encoder.c +++ b/src/libOggFLAC/stream_encoder.c @@ -712,7 +712,7 @@ FLAC__StreamEncoderWriteStatus write_callback_(const FLAC__StreamEncoder *unused void metadata_callback_(const FLAC__StreamEncoder *encoder, const FLAC__StreamMetadata *metadata, void *client_data) { /* - * We don't try to go back an update metadata blocks by mucking + * We don't try to go back and update metadata blocks by mucking * around inside the Ogg layer. Maybe someday we will care to * and an OggFLAC__SeekableStreamEncoder and OggFLAC__FileEncoder * will be possible but it may just never be useful. -- 2.7.4