From 774a127ed768de06eec34bc33999f4c3472532b8 Mon Sep 17 00:00:00 2001 From: Josh Coalson Date: Wed, 24 Sep 2003 22:12:32 +0000 Subject: [PATCH] minor syntax --- include/OggFLAC/file_decoder.h | 20 ++++++-------------- include/OggFLAC/seekable_stream_decoder.h | 12 +++++++++--- 2 files changed, 15 insertions(+), 17 deletions(-) diff --git a/include/OggFLAC/file_decoder.h b/include/OggFLAC/file_decoder.h index 799a3a9d..a5107440 100644 --- a/include/OggFLAC/file_decoder.h +++ b/include/OggFLAC/file_decoder.h @@ -77,6 +77,9 @@ typedef enum { OggFLAC__FILE_DECODER_OK = 0, /**< The decoder is in the normal OK state. */ + OggFLAC__FILE_DECODER_OGG_ERROR, + /**< An error occurred in the underlying Ogg layer. */ + OggFLAC__FILE_DECODER_FLAC_FILE_DECODER_ERROR, /**< An error occurred in the underlying FLAC file decoder; * check OggFLAC__file_decoder_get_FLAC_file_decoder_state(). @@ -317,7 +320,7 @@ OggFLAC_API FLAC__bool OggFLAC__file_decoder_set_serial_number(OggFLAC__FileDeco * \retval FLAC__bool * \c false if the decoder is already initialized, else \c true. */ -OggFLAC_API FLAC__bool OggFLAC__file_decoder_set_metadata_respond(OggFLAC__FileDecoder *decoder, OggFLAC__MetadataType type); +OggFLAC_API FLAC__bool OggFLAC__file_decoder_set_metadata_respond(OggFLAC__FileDecoder *decoder, FLAC__MetadataType type); /** This is inherited from FLAC__FileDecoder; see * FLAC__file_decoder_set_metadata_respond_application(). @@ -360,7 +363,7 @@ OggFLAC_API FLAC__bool OggFLAC__file_decoder_set_metadata_respond_all(OggFLAC__F * \retval FLAC__bool * \c false if the decoder is already initialized, else \c true. */ -OggFLAC_API FLAC__bool OggFLAC__file_decoder_set_metadata_ignore(OggFLAC__FileDecoder *decoder, OggFLAC__MetadataType type); +OggFLAC_API FLAC__bool OggFLAC__file_decoder_set_metadata_ignore(OggFLAC__FileDecoder *decoder, FLAC__MetadataType type); /** This is inherited from FLAC__FileDecoder; see * FLAC__file_decoder_set_metadata_ignore_application(). @@ -483,7 +486,7 @@ OggFLAC_API unsigned OggFLAC__file_decoder_get_channels(const OggFLAC__FileDecod * \retval OggFLAC__ChannelAssignment * See above. */ -OggFLAC_API OggFLAC__ChannelAssignment OggFLAC__file_decoder_get_channel_assignment(const OggFLAC__FileDecoder *decoder); +OggFLAC_API FLAC__ChannelAssignment OggFLAC__file_decoder_get_channel_assignment(const OggFLAC__FileDecoder *decoder); /** This is inherited from FLAC__FileDecoder; see * FLAC__file_decoder_get_bits_per_sample(). @@ -602,17 +605,6 @@ OggFLAC_API FLAC__bool OggFLAC__file_decoder_process_until_end_of_metadata(OggFL */ OggFLAC_API FLAC__bool OggFLAC__file_decoder_process_until_end_of_file(OggFLAC__FileDecoder *decoder); -/** This is inherited from FLAC__FileDecoder; see - * FLAC__file_decoder_process_remaining_frames(). - * - * \param decoder A decoder instance. - * \assert - * \code decoder != NULL \endcode - * \retval FLAC__bool - * See above. - */ -OggFLAC_API FLAC__bool OggFLAC__file_decoder_process_remaining_frames(OggFLAC__FileDecoder *decoder); - /** This is inherited from FLAC__FileDecoder; see * FLAC__file_decoder_seek_absolute(). * diff --git a/include/OggFLAC/seekable_stream_decoder.h b/include/OggFLAC/seekable_stream_decoder.h index 4388c9ba..fae181ea 100644 --- a/include/OggFLAC/seekable_stream_decoder.h +++ b/include/OggFLAC/seekable_stream_decoder.h @@ -77,11 +77,17 @@ typedef enum { OggFLAC__SEEKABLE_STREAM_DECODER_OK = 0, /**< The decoder is in the normal OK state. */ + OggFLAC__SEEKABLE_STREAM_DECODER_OGG_ERROR, + /**< An error occurred in the underlying Ogg layer. */ + OggFLAC__SEEKABLE_STREAM_DECODER_FLAC_SEEKABLE_STREAM_DECODER_ERROR, /**< An error occurred in the underlying FLAC seekable stream decoder; * check OggFLAC__seekable_stream_decoder_get_FLAC_seekable_stream_decoder_state(). */ + OggFLAC__SEEKABLE_STREAM_DECODER_READ_ERROR, + /**< The read callback returned an error. */ + OggFLAC__SEEKABLE_STREAM_DECODER_INVALID_CALLBACK, /**< The decoder was initialized before setting all the required callbacks. */ @@ -458,7 +464,7 @@ OggFLAC_API FLAC__bool OggFLAC__seekable_stream_decoder_set_serial_number(OggFLA * \retval FLAC__bool * \c false if the decoder is already initialized, else \c true. */ -OggFLAC_API FLAC__bool OggFLAC__seekable_stream_decoder_set_metadata_respond(OggFLAC__SeekableStreamDecoder *decoder, OggFLAC__MetadataType type); +OggFLAC_API FLAC__bool OggFLAC__seekable_stream_decoder_set_metadata_respond(OggFLAC__SeekableStreamDecoder *decoder, FLAC__MetadataType type); /** This is inherited from FLAC__SeekableStreamDecoder; see * FLAC__seekable_stream_decoder_set_metadata_respond_application(). @@ -501,7 +507,7 @@ OggFLAC_API FLAC__bool OggFLAC__seekable_stream_decoder_set_metadata_respond_all * \retval FLAC__bool * \c false if the decoder is already initialized, else \c true. */ -OggFLAC_API FLAC__bool OggFLAC__seekable_stream_decoder_set_metadata_ignore(OggFLAC__SeekableStreamDecoder *decoder, OggFLAC__MetadataType type); +OggFLAC_API FLAC__bool OggFLAC__seekable_stream_decoder_set_metadata_ignore(OggFLAC__SeekableStreamDecoder *decoder, FLAC__MetadataType type); /** This is inherited from FLAC__SeekableStreamDecoder; see * FLAC__seekable_stream_decoder_set_metadata_ignore_application(). @@ -610,7 +616,7 @@ OggFLAC_API unsigned OggFLAC__seekable_stream_decoder_get_channels(const OggFLAC * \retval OggFLAC__ChannelAssignment * See above. */ -OggFLAC_API OggFLAC__ChannelAssignment OggFLAC__seekable_stream_decoder_get_channel_assignment(const OggFLAC__SeekableStreamDecoder *decoder); +OggFLAC_API FLAC__ChannelAssignment OggFLAC__seekable_stream_decoder_get_channel_assignment(const OggFLAC__SeekableStreamDecoder *decoder); /** This is inherited from FLAC__SeekableStreamDecoder; see * FLAC__seekable_stream_decoder_get_bits_per_sample().