Chris@2: /* libFLAC - Free Lossless Audio Codec library Chris@2: * Copyright (C) 2000,2001,2002,2003,2004,2005,2006,2007 Josh Coalson Chris@2: * Chris@2: * Redistribution and use in source and binary forms, with or without Chris@2: * modification, are permitted provided that the following conditions Chris@2: * are met: Chris@2: * Chris@2: * - Redistributions of source code must retain the above copyright Chris@2: * notice, this list of conditions and the following disclaimer. Chris@2: * Chris@2: * - Redistributions in binary form must reproduce the above copyright Chris@2: * notice, this list of conditions and the following disclaimer in the Chris@2: * documentation and/or other materials provided with the distribution. Chris@2: * Chris@2: * - Neither the name of the Xiph.org Foundation nor the names of its Chris@2: * contributors may be used to endorse or promote products derived from Chris@2: * this software without specific prior written permission. Chris@2: * Chris@2: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS Chris@2: * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT Chris@2: * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR Chris@2: * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR Chris@2: * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, Chris@2: * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, Chris@2: * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR Chris@2: * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF Chris@2: * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING Chris@2: * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS Chris@2: * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. Chris@2: */ Chris@2: Chris@2: #ifndef FLAC__STREAM_DECODER_H Chris@2: #define FLAC__STREAM_DECODER_H Chris@2: Chris@2: #include /* for FILE */ Chris@2: #include "export.h" Chris@2: #include "format.h" Chris@2: Chris@2: #ifdef __cplusplus Chris@2: extern "C" { Chris@2: #endif Chris@2: Chris@2: Chris@2: /** \file include/FLAC/stream_decoder.h Chris@2: * Chris@2: * \brief Chris@2: * This module contains the functions which implement the stream Chris@2: * decoder. Chris@2: * Chris@2: * See the detailed documentation in the Chris@2: * \link flac_stream_decoder stream decoder \endlink module. Chris@2: */ Chris@2: Chris@2: /** \defgroup flac_decoder FLAC/ \*_decoder.h: decoder interfaces Chris@2: * \ingroup flac Chris@2: * Chris@2: * \brief Chris@2: * This module describes the decoder layers provided by libFLAC. Chris@2: * Chris@2: * The stream decoder can be used to decode complete streams either from Chris@2: * the client via callbacks, or directly from a file, depending on how Chris@2: * it is initialized. When decoding via callbacks, the client provides Chris@2: * callbacks for reading FLAC data and writing decoded samples, and Chris@2: * handling metadata and errors. If the client also supplies seek-related Chris@2: * callback, the decoder function for sample-accurate seeking within the Chris@2: * FLAC input is also available. When decoding from a file, the client Chris@2: * needs only supply a filename or open \c FILE* and write/metadata/error Chris@2: * callbacks; the rest of the callbacks are supplied internally. For more Chris@2: * info see the \link flac_stream_decoder stream decoder \endlink module. Chris@2: */ Chris@2: Chris@2: /** \defgroup flac_stream_decoder FLAC/stream_decoder.h: stream decoder interface Chris@2: * \ingroup flac_decoder Chris@2: * Chris@2: * \brief Chris@2: * This module contains the functions which implement the stream Chris@2: * decoder. Chris@2: * Chris@2: * The stream decoder can decode native FLAC, and optionally Ogg FLAC Chris@2: * (check FLAC_API_SUPPORTS_OGG_FLAC) streams and files. Chris@2: * Chris@2: * The basic usage of this decoder is as follows: Chris@2: * - The program creates an instance of a decoder using Chris@2: * FLAC__stream_decoder_new(). Chris@2: * - The program overrides the default settings using Chris@2: * FLAC__stream_decoder_set_*() functions. Chris@2: * - The program initializes the instance to validate the settings and Chris@2: * prepare for decoding using Chris@2: * - FLAC__stream_decoder_init_stream() or FLAC__stream_decoder_init_FILE() Chris@2: * or FLAC__stream_decoder_init_file() for native FLAC, Chris@2: * - FLAC__stream_decoder_init_ogg_stream() or FLAC__stream_decoder_init_ogg_FILE() Chris@2: * or FLAC__stream_decoder_init_ogg_file() for Ogg FLAC Chris@2: * - The program calls the FLAC__stream_decoder_process_*() functions Chris@2: * to decode data, which subsequently calls the callbacks. Chris@2: * - The program finishes the decoding with FLAC__stream_decoder_finish(), Chris@2: * which flushes the input and output and resets the decoder to the Chris@2: * uninitialized state. Chris@2: * - The instance may be used again or deleted with Chris@2: * FLAC__stream_decoder_delete(). Chris@2: * Chris@2: * In more detail, the program will create a new instance by calling Chris@2: * FLAC__stream_decoder_new(), then call FLAC__stream_decoder_set_*() Chris@2: * functions to override the default decoder options, and call Chris@2: * one of the FLAC__stream_decoder_init_*() functions. Chris@2: * Chris@2: * There are three initialization functions for native FLAC, one for Chris@2: * setting up the decoder to decode FLAC data from the client via Chris@2: * callbacks, and two for decoding directly from a FLAC file. Chris@2: * Chris@2: * For decoding via callbacks, use FLAC__stream_decoder_init_stream(). Chris@2: * You must also supply several callbacks for handling I/O. Some (like Chris@2: * seeking) are optional, depending on the capabilities of the input. Chris@2: * Chris@2: * For decoding directly from a file, use FLAC__stream_decoder_init_FILE() Chris@2: * or FLAC__stream_decoder_init_file(). Then you must only supply an open Chris@2: * \c FILE* or filename and fewer callbacks; the decoder will handle Chris@2: * the other callbacks internally. Chris@2: * Chris@2: * There are three similarly-named init functions for decoding from Ogg Chris@2: * FLAC streams. Check \c FLAC_API_SUPPORTS_OGG_FLAC to find out if the Chris@2: * library has been built with Ogg support. Chris@2: * Chris@2: * Once the decoder is initialized, your program will call one of several Chris@2: * functions to start the decoding process: Chris@2: * Chris@2: * - FLAC__stream_decoder_process_single() - Tells the decoder to process at Chris@2: * most one metadata block or audio frame and return, calling either the Chris@2: * metadata callback or write callback, respectively, once. If the decoder Chris@2: * loses sync it will return with only the error callback being called. Chris@2: * - FLAC__stream_decoder_process_until_end_of_metadata() - Tells the decoder Chris@2: * to process the stream from the current location and stop upon reaching Chris@2: * the first audio frame. The client will get one metadata, write, or error Chris@2: * callback per metadata block, audio frame, or sync error, respectively. Chris@2: * - FLAC__stream_decoder_process_until_end_of_stream() - Tells the decoder Chris@2: * to process the stream from the current location until the read callback Chris@2: * returns FLAC__STREAM_DECODER_READ_STATUS_END_OF_STREAM or Chris@2: * FLAC__STREAM_DECODER_READ_STATUS_ABORT. The client will get one metadata, Chris@2: * write, or error callback per metadata block, audio frame, or sync error, Chris@2: * respectively. Chris@2: * Chris@2: * When the decoder has finished decoding (normally or through an abort), Chris@2: * the instance is finished by calling FLAC__stream_decoder_finish(), which Chris@2: * ensures the decoder is in the correct state and frees memory. Then the Chris@2: * instance may be deleted with FLAC__stream_decoder_delete() or initialized Chris@2: * again to decode another stream. Chris@2: * Chris@2: * Seeking is exposed through the FLAC__stream_decoder_seek_absolute() method. Chris@2: * At any point after the stream decoder has been initialized, the client can Chris@2: * call this function to seek to an exact sample within the stream. Chris@2: * Subsequently, the first time the write callback is called it will be Chris@2: * passed a (possibly partial) block starting at that sample. Chris@2: * Chris@2: * If the client cannot seek via the callback interface provided, but still Chris@2: * has another way of seeking, it can flush the decoder using Chris@2: * FLAC__stream_decoder_flush() and start feeding data from the new position Chris@2: * through the read callback. Chris@2: * Chris@2: * The stream decoder also provides MD5 signature checking. If this is Chris@2: * turned on before initialization, FLAC__stream_decoder_finish() will Chris@2: * report when the decoded MD5 signature does not match the one stored Chris@2: * in the STREAMINFO block. MD5 checking is automatically turned off Chris@2: * (until the next FLAC__stream_decoder_reset()) if there is no signature Chris@2: * in the STREAMINFO block or when a seek is attempted. Chris@2: * Chris@2: * The FLAC__stream_decoder_set_metadata_*() functions deserve special Chris@2: * attention. By default, the decoder only calls the metadata_callback for Chris@2: * the STREAMINFO block. These functions allow you to tell the decoder Chris@2: * explicitly which blocks to parse and return via the metadata_callback Chris@2: * and/or which to skip. Use a FLAC__stream_decoder_set_metadata_respond_all(), Chris@2: * FLAC__stream_decoder_set_metadata_ignore() ... or FLAC__stream_decoder_set_metadata_ignore_all(), Chris@2: * FLAC__stream_decoder_set_metadata_respond() ... sequence to exactly specify Chris@2: * which blocks to return. Remember that metadata blocks can potentially Chris@2: * be big (for example, cover art) so filtering out the ones you don't Chris@2: * use can reduce the memory requirements of the decoder. Also note the Chris@2: * special forms FLAC__stream_decoder_set_metadata_respond_application(id) Chris@2: * and FLAC__stream_decoder_set_metadata_ignore_application(id) for Chris@2: * filtering APPLICATION blocks based on the application ID. Chris@2: * Chris@2: * STREAMINFO and SEEKTABLE blocks are always parsed and used internally, but Chris@2: * they still can legally be filtered from the metadata_callback. Chris@2: * Chris@2: * \note Chris@2: * The "set" functions may only be called when the decoder is in the Chris@2: * state FLAC__STREAM_DECODER_UNINITIALIZED, i.e. after Chris@2: * FLAC__stream_decoder_new() or FLAC__stream_decoder_finish(), but Chris@2: * before FLAC__stream_decoder_init_*(). If this is the case they will Chris@2: * return \c true, otherwise \c false. Chris@2: * Chris@2: * \note Chris@2: * FLAC__stream_decoder_finish() resets all settings to the constructor Chris@2: * defaults, including the callbacks. Chris@2: * Chris@2: * \{ Chris@2: */ Chris@2: Chris@2: Chris@2: /** State values for a FLAC__StreamDecoder Chris@2: * Chris@2: * The decoder's state can be obtained by calling FLAC__stream_decoder_get_state(). Chris@2: */ Chris@2: typedef enum { Chris@2: Chris@2: FLAC__STREAM_DECODER_SEARCH_FOR_METADATA = 0, Chris@2: /**< The decoder is ready to search for metadata. */ Chris@2: Chris@2: FLAC__STREAM_DECODER_READ_METADATA, Chris@2: /**< The decoder is ready to or is in the process of reading metadata. */ Chris@2: Chris@2: FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC, Chris@2: /**< The decoder is ready to or is in the process of searching for the Chris@2: * frame sync code. Chris@2: */ Chris@2: Chris@2: FLAC__STREAM_DECODER_READ_FRAME, Chris@2: /**< The decoder is ready to or is in the process of reading a frame. */ Chris@2: Chris@2: FLAC__STREAM_DECODER_END_OF_STREAM, Chris@2: /**< The decoder has reached the end of the stream. */ Chris@2: Chris@2: FLAC__STREAM_DECODER_OGG_ERROR, Chris@2: /**< An error occurred in the underlying Ogg layer. */ Chris@2: Chris@2: FLAC__STREAM_DECODER_SEEK_ERROR, Chris@2: /**< An error occurred while seeking. The decoder must be flushed Chris@2: * with FLAC__stream_decoder_flush() or reset with Chris@2: * FLAC__stream_decoder_reset() before decoding can continue. Chris@2: */ Chris@2: Chris@2: FLAC__STREAM_DECODER_ABORTED, Chris@2: /**< The decoder was aborted by the read callback. */ Chris@2: Chris@2: FLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR, Chris@2: /**< An error occurred allocating memory. The decoder is in an invalid Chris@2: * state and can no longer be used. Chris@2: */ Chris@2: Chris@2: FLAC__STREAM_DECODER_UNINITIALIZED Chris@2: /**< The decoder is in the uninitialized state; one of the Chris@2: * FLAC__stream_decoder_init_*() functions must be called before samples Chris@2: * can be processed. Chris@2: */ Chris@2: Chris@2: } FLAC__StreamDecoderState; Chris@2: Chris@2: /** Maps a FLAC__StreamDecoderState to a C string. Chris@2: * Chris@2: * Using a FLAC__StreamDecoderState as the index to this array Chris@2: * will give the string equivalent. The contents should not be modified. Chris@2: */ Chris@2: extern FLAC_API const char * const FLAC__StreamDecoderStateString[]; Chris@2: Chris@2: Chris@2: /** Possible return values for the FLAC__stream_decoder_init_*() functions. Chris@2: */ Chris@2: typedef enum { Chris@2: Chris@2: FLAC__STREAM_DECODER_INIT_STATUS_OK = 0, Chris@2: /**< Initialization was successful. */ Chris@2: Chris@2: FLAC__STREAM_DECODER_INIT_STATUS_UNSUPPORTED_CONTAINER, Chris@2: /**< The library was not compiled with support for the given container Chris@2: * format. Chris@2: */ Chris@2: Chris@2: FLAC__STREAM_DECODER_INIT_STATUS_INVALID_CALLBACKS, Chris@2: /**< A required callback was not supplied. */ Chris@2: Chris@2: FLAC__STREAM_DECODER_INIT_STATUS_MEMORY_ALLOCATION_ERROR, Chris@2: /**< An error occurred allocating memory. */ Chris@2: Chris@2: FLAC__STREAM_DECODER_INIT_STATUS_ERROR_OPENING_FILE, Chris@2: /**< fopen() failed in FLAC__stream_decoder_init_file() or Chris@2: * FLAC__stream_decoder_init_ogg_file(). */ Chris@2: Chris@2: FLAC__STREAM_DECODER_INIT_STATUS_ALREADY_INITIALIZED Chris@2: /**< FLAC__stream_decoder_init_*() was called when the decoder was Chris@2: * already initialized, usually because Chris@2: * FLAC__stream_decoder_finish() was not called. Chris@2: */ Chris@2: Chris@2: } FLAC__StreamDecoderInitStatus; Chris@2: Chris@2: /** Maps a FLAC__StreamDecoderInitStatus to a C string. Chris@2: * Chris@2: * Using a FLAC__StreamDecoderInitStatus as the index to this array Chris@2: * will give the string equivalent. The contents should not be modified. Chris@2: */ Chris@2: extern FLAC_API const char * const FLAC__StreamDecoderInitStatusString[]; Chris@2: Chris@2: Chris@2: /** Return values for the FLAC__StreamDecoder read callback. Chris@2: */ Chris@2: typedef enum { Chris@2: Chris@2: FLAC__STREAM_DECODER_READ_STATUS_CONTINUE, Chris@2: /**< The read was OK and decoding can continue. */ Chris@2: Chris@2: FLAC__STREAM_DECODER_READ_STATUS_END_OF_STREAM, Chris@2: /**< The read was attempted while at the end of the stream. Note that Chris@2: * the client must only return this value when the read callback was Chris@2: * called when already at the end of the stream. Otherwise, if the read Chris@2: * itself moves to the end of the stream, the client should still return Chris@2: * the data and \c FLAC__STREAM_DECODER_READ_STATUS_CONTINUE, and then on Chris@2: * the next read callback it should return Chris@2: * \c FLAC__STREAM_DECODER_READ_STATUS_END_OF_STREAM with a byte count Chris@2: * of \c 0. Chris@2: */ Chris@2: Chris@2: FLAC__STREAM_DECODER_READ_STATUS_ABORT Chris@2: /**< An unrecoverable error occurred. The decoder will return from the process call. */ Chris@2: Chris@2: } FLAC__StreamDecoderReadStatus; Chris@2: Chris@2: /** Maps a FLAC__StreamDecoderReadStatus to a C string. Chris@2: * Chris@2: * Using a FLAC__StreamDecoderReadStatus as the index to this array Chris@2: * will give the string equivalent. The contents should not be modified. Chris@2: */ Chris@2: extern FLAC_API const char * const FLAC__StreamDecoderReadStatusString[]; Chris@2: Chris@2: Chris@2: /** Return values for the FLAC__StreamDecoder seek callback. Chris@2: */ Chris@2: typedef enum { Chris@2: Chris@2: FLAC__STREAM_DECODER_SEEK_STATUS_OK, Chris@2: /**< The seek was OK and decoding can continue. */ Chris@2: Chris@2: FLAC__STREAM_DECODER_SEEK_STATUS_ERROR, Chris@2: /**< An unrecoverable error occurred. The decoder will return from the process call. */ Chris@2: Chris@2: FLAC__STREAM_DECODER_SEEK_STATUS_UNSUPPORTED Chris@2: /**< Client does not support seeking. */ Chris@2: Chris@2: } FLAC__StreamDecoderSeekStatus; Chris@2: Chris@2: /** Maps a FLAC__StreamDecoderSeekStatus to a C string. Chris@2: * Chris@2: * Using a FLAC__StreamDecoderSeekStatus as the index to this array Chris@2: * will give the string equivalent. The contents should not be modified. Chris@2: */ Chris@2: extern FLAC_API const char * const FLAC__StreamDecoderSeekStatusString[]; Chris@2: Chris@2: Chris@2: /** Return values for the FLAC__StreamDecoder tell callback. Chris@2: */ Chris@2: typedef enum { Chris@2: Chris@2: FLAC__STREAM_DECODER_TELL_STATUS_OK, Chris@2: /**< The tell was OK and decoding can continue. */ Chris@2: Chris@2: FLAC__STREAM_DECODER_TELL_STATUS_ERROR, Chris@2: /**< An unrecoverable error occurred. The decoder will return from the process call. */ Chris@2: Chris@2: FLAC__STREAM_DECODER_TELL_STATUS_UNSUPPORTED Chris@2: /**< Client does not support telling the position. */ Chris@2: Chris@2: } FLAC__StreamDecoderTellStatus; Chris@2: Chris@2: /** Maps a FLAC__StreamDecoderTellStatus to a C string. Chris@2: * Chris@2: * Using a FLAC__StreamDecoderTellStatus as the index to this array Chris@2: * will give the string equivalent. The contents should not be modified. Chris@2: */ Chris@2: extern FLAC_API const char * const FLAC__StreamDecoderTellStatusString[]; Chris@2: Chris@2: Chris@2: /** Return values for the FLAC__StreamDecoder length callback. Chris@2: */ Chris@2: typedef enum { Chris@2: Chris@2: FLAC__STREAM_DECODER_LENGTH_STATUS_OK, Chris@2: /**< The length call was OK and decoding can continue. */ Chris@2: Chris@2: FLAC__STREAM_DECODER_LENGTH_STATUS_ERROR, Chris@2: /**< An unrecoverable error occurred. The decoder will return from the process call. */ Chris@2: Chris@2: FLAC__STREAM_DECODER_LENGTH_STATUS_UNSUPPORTED Chris@2: /**< Client does not support reporting the length. */ Chris@2: Chris@2: } FLAC__StreamDecoderLengthStatus; Chris@2: Chris@2: /** Maps a FLAC__StreamDecoderLengthStatus to a C string. Chris@2: * Chris@2: * Using a FLAC__StreamDecoderLengthStatus as the index to this array Chris@2: * will give the string equivalent. The contents should not be modified. Chris@2: */ Chris@2: extern FLAC_API const char * const FLAC__StreamDecoderLengthStatusString[]; Chris@2: Chris@2: Chris@2: /** Return values for the FLAC__StreamDecoder write callback. Chris@2: */ Chris@2: typedef enum { Chris@2: Chris@2: FLAC__STREAM_DECODER_WRITE_STATUS_CONTINUE, Chris@2: /**< The write was OK and decoding can continue. */ Chris@2: Chris@2: FLAC__STREAM_DECODER_WRITE_STATUS_ABORT Chris@2: /**< An unrecoverable error occurred. The decoder will return from the process call. */ Chris@2: Chris@2: } FLAC__StreamDecoderWriteStatus; Chris@2: Chris@2: /** Maps a FLAC__StreamDecoderWriteStatus to a C string. Chris@2: * Chris@2: * Using a FLAC__StreamDecoderWriteStatus as the index to this array Chris@2: * will give the string equivalent. The contents should not be modified. Chris@2: */ Chris@2: extern FLAC_API const char * const FLAC__StreamDecoderWriteStatusString[]; Chris@2: Chris@2: Chris@2: /** Possible values passed back to the FLAC__StreamDecoder error callback. Chris@2: * \c FLAC__STREAM_DECODER_ERROR_STATUS_LOST_SYNC is the generic catch- Chris@2: * all. The rest could be caused by bad sync (false synchronization on Chris@2: * data that is not the start of a frame) or corrupted data. The error Chris@2: * itself is the decoder's best guess at what happened assuming a correct Chris@2: * sync. For example \c FLAC__STREAM_DECODER_ERROR_STATUS_BAD_HEADER Chris@2: * could be caused by a correct sync on the start of a frame, but some Chris@2: * data in the frame header was corrupted. Or it could be the result of Chris@2: * syncing on a point the stream that looked like the starting of a frame Chris@2: * but was not. \c FLAC__STREAM_DECODER_ERROR_STATUS_UNPARSEABLE_STREAM Chris@2: * could be because the decoder encountered a valid frame made by a future Chris@2: * version of the encoder which it cannot parse, or because of a false Chris@2: * sync making it appear as though an encountered frame was generated by Chris@2: * a future encoder. Chris@2: */ Chris@2: typedef enum { Chris@2: Chris@2: FLAC__STREAM_DECODER_ERROR_STATUS_LOST_SYNC, Chris@2: /**< An error in the stream caused the decoder to lose synchronization. */ Chris@2: Chris@2: FLAC__STREAM_DECODER_ERROR_STATUS_BAD_HEADER, Chris@2: /**< The decoder encountered a corrupted frame header. */ Chris@2: Chris@2: FLAC__STREAM_DECODER_ERROR_STATUS_FRAME_CRC_MISMATCH, Chris@2: /**< The frame's data did not match the CRC in the footer. */ Chris@2: Chris@2: FLAC__STREAM_DECODER_ERROR_STATUS_UNPARSEABLE_STREAM Chris@2: /**< The decoder encountered reserved fields in use in the stream. */ Chris@2: Chris@2: } FLAC__StreamDecoderErrorStatus; Chris@2: Chris@2: /** Maps a FLAC__StreamDecoderErrorStatus to a C string. Chris@2: * Chris@2: * Using a FLAC__StreamDecoderErrorStatus as the index to this array Chris@2: * will give the string equivalent. The contents should not be modified. Chris@2: */ Chris@2: extern FLAC_API const char * const FLAC__StreamDecoderErrorStatusString[]; Chris@2: Chris@2: Chris@2: /*********************************************************************** Chris@2: * Chris@2: * class FLAC__StreamDecoder Chris@2: * Chris@2: ***********************************************************************/ Chris@2: Chris@2: struct FLAC__StreamDecoderProtected; Chris@2: struct FLAC__StreamDecoderPrivate; Chris@2: /** The opaque structure definition for the stream decoder type. Chris@2: * See the \link flac_stream_decoder stream decoder module \endlink Chris@2: * for a detailed description. Chris@2: */ Chris@2: typedef struct { Chris@2: struct FLAC__StreamDecoderProtected *protected_; /* avoid the C++ keyword 'protected' */ Chris@2: struct FLAC__StreamDecoderPrivate *private_; /* avoid the C++ keyword 'private' */ Chris@2: } FLAC__StreamDecoder; Chris@2: Chris@2: /** Signature for the read callback. Chris@2: * Chris@2: * A function pointer matching this signature must be passed to Chris@2: * FLAC__stream_decoder_init*_stream(). The supplied function will be Chris@2: * called when the decoder needs more input data. The address of the Chris@2: * buffer to be filled is supplied, along with the number of bytes the Chris@2: * buffer can hold. The callback may choose to supply less data and Chris@2: * modify the byte count but must be careful not to overflow the buffer. Chris@2: * The callback then returns a status code chosen from Chris@2: * FLAC__StreamDecoderReadStatus. Chris@2: * Chris@2: * Here is an example of a read callback for stdio streams: Chris@2: * \code Chris@2: * FLAC__StreamDecoderReadStatus read_cb(const FLAC__StreamDecoder *decoder, FLAC__byte buffer[], size_t *bytes, void *client_data) Chris@2: * { Chris@2: * FILE *file = ((MyClientData*)client_data)->file; Chris@2: * if(*bytes > 0) { Chris@2: * *bytes = fread(buffer, sizeof(FLAC__byte), *bytes, file); Chris@2: * if(ferror(file)) Chris@2: * return FLAC__STREAM_DECODER_READ_STATUS_ABORT; Chris@2: * else if(*bytes == 0) Chris@2: * return FLAC__STREAM_DECODER_READ_STATUS_END_OF_STREAM; Chris@2: * else Chris@2: * return FLAC__STREAM_DECODER_READ_STATUS_CONTINUE; Chris@2: * } Chris@2: * else Chris@2: * return FLAC__STREAM_DECODER_READ_STATUS_ABORT; Chris@2: * } Chris@2: * \endcode Chris@2: * Chris@2: * \note In general, FLAC__StreamDecoder functions which change the Chris@2: * state should not be called on the \a decoder while in the callback. Chris@2: * Chris@2: * \param decoder The decoder instance calling the callback. Chris@2: * \param buffer A pointer to a location for the callee to store Chris@2: * data to be decoded. Chris@2: * \param bytes A pointer to the size of the buffer. On entry Chris@2: * to the callback, it contains the maximum number Chris@2: * of bytes that may be stored in \a buffer. The Chris@2: * callee must set it to the actual number of bytes Chris@2: * stored (0 in case of error or end-of-stream) before Chris@2: * returning. Chris@2: * \param client_data The callee's client data set through Chris@2: * FLAC__stream_decoder_init_*(). Chris@2: * \retval FLAC__StreamDecoderReadStatus Chris@2: * The callee's return status. Note that the callback should return Chris@2: * \c FLAC__STREAM_DECODER_READ_STATUS_END_OF_STREAM if and only if Chris@2: * zero bytes were read and there is no more data to be read. Chris@2: */ Chris@2: typedef FLAC__StreamDecoderReadStatus (*FLAC__StreamDecoderReadCallback)(const FLAC__StreamDecoder *decoder, FLAC__byte buffer[], size_t *bytes, void *client_data); Chris@2: Chris@2: /** Signature for the seek callback. Chris@2: * Chris@2: * A function pointer matching this signature may be passed to Chris@2: * FLAC__stream_decoder_init*_stream(). The supplied function will be Chris@2: * called when the decoder needs to seek the input stream. The decoder Chris@2: * will pass the absolute byte offset to seek to, 0 meaning the Chris@2: * beginning of the stream. Chris@2: * Chris@2: * Here is an example of a seek callback for stdio streams: Chris@2: * \code Chris@2: * FLAC__StreamDecoderSeekStatus seek_cb(const FLAC__StreamDecoder *decoder, FLAC__uint64 absolute_byte_offset, void *client_data) Chris@2: * { Chris@2: * FILE *file = ((MyClientData*)client_data)->file; Chris@2: * if(file == stdin) Chris@2: * return FLAC__STREAM_DECODER_SEEK_STATUS_UNSUPPORTED; Chris@2: * else if(fseeko(file, (off_t)absolute_byte_offset, SEEK_SET) < 0) Chris@2: * return FLAC__STREAM_DECODER_SEEK_STATUS_ERROR; Chris@2: * else Chris@2: * return FLAC__STREAM_DECODER_SEEK_STATUS_OK; Chris@2: * } Chris@2: * \endcode Chris@2: * Chris@2: * \note In general, FLAC__StreamDecoder functions which change the Chris@2: * state should not be called on the \a decoder while in the callback. Chris@2: * Chris@2: * \param decoder The decoder instance calling the callback. Chris@2: * \param absolute_byte_offset The offset from the beginning of the stream Chris@2: * to seek to. Chris@2: * \param client_data The callee's client data set through Chris@2: * FLAC__stream_decoder_init_*(). Chris@2: * \retval FLAC__StreamDecoderSeekStatus Chris@2: * The callee's return status. Chris@2: */ Chris@2: typedef FLAC__StreamDecoderSeekStatus (*FLAC__StreamDecoderSeekCallback)(const FLAC__StreamDecoder *decoder, FLAC__uint64 absolute_byte_offset, void *client_data); Chris@2: Chris@2: /** Signature for the tell callback. Chris@2: * Chris@2: * A function pointer matching this signature may be passed to Chris@2: * FLAC__stream_decoder_init*_stream(). The supplied function will be Chris@2: * called when the decoder wants to know the current position of the Chris@2: * stream. The callback should return the byte offset from the Chris@2: * beginning of the stream. Chris@2: * Chris@2: * Here is an example of a tell callback for stdio streams: Chris@2: * \code Chris@2: * FLAC__StreamDecoderTellStatus tell_cb(const FLAC__StreamDecoder *decoder, FLAC__uint64 *absolute_byte_offset, void *client_data) Chris@2: * { Chris@2: * FILE *file = ((MyClientData*)client_data)->file; Chris@2: * off_t pos; Chris@2: * if(file == stdin) Chris@2: * return FLAC__STREAM_DECODER_TELL_STATUS_UNSUPPORTED; Chris@2: * else if((pos = ftello(file)) < 0) Chris@2: * return FLAC__STREAM_DECODER_TELL_STATUS_ERROR; Chris@2: * else { Chris@2: * *absolute_byte_offset = (FLAC__uint64)pos; Chris@2: * return FLAC__STREAM_DECODER_TELL_STATUS_OK; Chris@2: * } Chris@2: * } Chris@2: * \endcode Chris@2: * Chris@2: * \note In general, FLAC__StreamDecoder functions which change the Chris@2: * state should not be called on the \a decoder while in the callback. Chris@2: * Chris@2: * \param decoder The decoder instance calling the callback. Chris@2: * \param absolute_byte_offset A pointer to storage for the current offset Chris@2: * from the beginning of the stream. Chris@2: * \param client_data The callee's client data set through Chris@2: * FLAC__stream_decoder_init_*(). Chris@2: * \retval FLAC__StreamDecoderTellStatus Chris@2: * The callee's return status. Chris@2: */ Chris@2: typedef FLAC__StreamDecoderTellStatus (*FLAC__StreamDecoderTellCallback)(const FLAC__StreamDecoder *decoder, FLAC__uint64 *absolute_byte_offset, void *client_data); Chris@2: Chris@2: /** Signature for the length callback. Chris@2: * Chris@2: * A function pointer matching this signature may be passed to Chris@2: * FLAC__stream_decoder_init*_stream(). The supplied function will be Chris@2: * called when the decoder wants to know the total length of the stream Chris@2: * in bytes. Chris@2: * Chris@2: * Here is an example of a length callback for stdio streams: Chris@2: * \code Chris@2: * FLAC__StreamDecoderLengthStatus length_cb(const FLAC__StreamDecoder *decoder, FLAC__uint64 *stream_length, void *client_data) Chris@2: * { Chris@2: * FILE *file = ((MyClientData*)client_data)->file; Chris@2: * struct stat filestats; Chris@2: * Chris@2: * if(file == stdin) Chris@2: * return FLAC__STREAM_DECODER_LENGTH_STATUS_UNSUPPORTED; Chris@2: * else if(fstat(fileno(file), &filestats) != 0) Chris@2: * return FLAC__STREAM_DECODER_LENGTH_STATUS_ERROR; Chris@2: * else { Chris@2: * *stream_length = (FLAC__uint64)filestats.st_size; Chris@2: * return FLAC__STREAM_DECODER_LENGTH_STATUS_OK; Chris@2: * } Chris@2: * } Chris@2: * \endcode Chris@2: * Chris@2: * \note In general, FLAC__StreamDecoder functions which change the Chris@2: * state should not be called on the \a decoder while in the callback. Chris@2: * Chris@2: * \param decoder The decoder instance calling the callback. Chris@2: * \param stream_length A pointer to storage for the length of the stream Chris@2: * in bytes. Chris@2: * \param client_data The callee's client data set through Chris@2: * FLAC__stream_decoder_init_*(). Chris@2: * \retval FLAC__StreamDecoderLengthStatus Chris@2: * The callee's return status. Chris@2: */ Chris@2: typedef FLAC__StreamDecoderLengthStatus (*FLAC__StreamDecoderLengthCallback)(const FLAC__StreamDecoder *decoder, FLAC__uint64 *stream_length, void *client_data); Chris@2: Chris@2: /** Signature for the EOF callback. Chris@2: * Chris@2: * A function pointer matching this signature may be passed to Chris@2: * FLAC__stream_decoder_init*_stream(). The supplied function will be Chris@2: * called when the decoder needs to know if the end of the stream has Chris@2: * been reached. Chris@2: * Chris@2: * Here is an example of a EOF callback for stdio streams: Chris@2: * FLAC__bool eof_cb(const FLAC__StreamDecoder *decoder, void *client_data) Chris@2: * \code Chris@2: * { Chris@2: * FILE *file = ((MyClientData*)client_data)->file; Chris@2: * return feof(file)? true : false; Chris@2: * } Chris@2: * \endcode Chris@2: * Chris@2: * \note In general, FLAC__StreamDecoder functions which change the Chris@2: * state should not be called on the \a decoder while in the callback. Chris@2: * Chris@2: * \param decoder The decoder instance calling the callback. Chris@2: * \param client_data The callee's client data set through Chris@2: * FLAC__stream_decoder_init_*(). Chris@2: * \retval FLAC__bool Chris@2: * \c true if the currently at the end of the stream, else \c false. Chris@2: */ Chris@2: typedef FLAC__bool (*FLAC__StreamDecoderEofCallback)(const FLAC__StreamDecoder *decoder, void *client_data); Chris@2: Chris@2: /** Signature for the write callback. Chris@2: * Chris@2: * A function pointer matching this signature must be passed to one of Chris@2: * the FLAC__stream_decoder_init_*() functions. Chris@2: * The supplied function will be called when the decoder has decoded a Chris@2: * single audio frame. The decoder will pass the frame metadata as well Chris@2: * as an array of pointers (one for each channel) pointing to the Chris@2: * decoded audio. Chris@2: * Chris@2: * \note In general, FLAC__StreamDecoder functions which change the Chris@2: * state should not be called on the \a decoder while in the callback. Chris@2: * Chris@2: * \param decoder The decoder instance calling the callback. Chris@2: * \param frame The description of the decoded frame. See Chris@2: * FLAC__Frame. Chris@2: * \param buffer An array of pointers to decoded channels of data. Chris@2: * Each pointer will point to an array of signed Chris@2: * samples of length \a frame->header.blocksize. Chris@2: * Channels will be ordered according to the FLAC Chris@2: * specification; see the documentation for the Chris@2: * frame header. Chris@2: * \param client_data The callee's client data set through Chris@2: * FLAC__stream_decoder_init_*(). Chris@2: * \retval FLAC__StreamDecoderWriteStatus Chris@2: * The callee's return status. Chris@2: */ Chris@2: typedef FLAC__StreamDecoderWriteStatus (*FLAC__StreamDecoderWriteCallback)(const FLAC__StreamDecoder *decoder, const FLAC__Frame *frame, const FLAC__int32 * const buffer[], void *client_data); Chris@2: Chris@2: /** Signature for the metadata callback. Chris@2: * Chris@2: * A function pointer matching this signature must be passed to one of Chris@2: * the FLAC__stream_decoder_init_*() functions. Chris@2: * The supplied function will be called when the decoder has decoded a Chris@2: * metadata block. In a valid FLAC file there will always be one Chris@2: * \c STREAMINFO block, followed by zero or more other metadata blocks. Chris@2: * These will be supplied by the decoder in the same order as they Chris@2: * appear in the stream and always before the first audio frame (i.e. Chris@2: * write callback). The metadata block that is passed in must not be Chris@2: * modified, and it doesn't live beyond the callback, so you should make Chris@2: * a copy of it with FLAC__metadata_object_clone() if you will need it Chris@2: * elsewhere. Since metadata blocks can potentially be large, by Chris@2: * default the decoder only calls the metadata callback for the Chris@2: * \c STREAMINFO block; you can instruct the decoder to pass or filter Chris@2: * other blocks with FLAC__stream_decoder_set_metadata_*() calls. Chris@2: * Chris@2: * \note In general, FLAC__StreamDecoder functions which change the Chris@2: * state should not be called on the \a decoder while in the callback. Chris@2: * Chris@2: * \param decoder The decoder instance calling the callback. Chris@2: * \param metadata The decoded metadata block. Chris@2: * \param client_data The callee's client data set through Chris@2: * FLAC__stream_decoder_init_*(). Chris@2: */ Chris@2: typedef void (*FLAC__StreamDecoderMetadataCallback)(const FLAC__StreamDecoder *decoder, const FLAC__StreamMetadata *metadata, void *client_data); Chris@2: Chris@2: /** Signature for the error callback. Chris@2: * Chris@2: * A function pointer matching this signature must be passed to one of Chris@2: * the FLAC__stream_decoder_init_*() functions. Chris@2: * The supplied function will be called whenever an error occurs during Chris@2: * decoding. Chris@2: * Chris@2: * \note In general, FLAC__StreamDecoder functions which change the Chris@2: * state should not be called on the \a decoder while in the callback. Chris@2: * Chris@2: * \param decoder The decoder instance calling the callback. Chris@2: * \param status The error encountered by the decoder. Chris@2: * \param client_data The callee's client data set through Chris@2: * FLAC__stream_decoder_init_*(). Chris@2: */ Chris@2: typedef void (*FLAC__StreamDecoderErrorCallback)(const FLAC__StreamDecoder *decoder, FLAC__StreamDecoderErrorStatus status, void *client_data); Chris@2: Chris@2: Chris@2: /*********************************************************************** Chris@2: * Chris@2: * Class constructor/destructor Chris@2: * Chris@2: ***********************************************************************/ Chris@2: Chris@2: /** Create a new stream decoder instance. The instance is created with Chris@2: * default settings; see the individual FLAC__stream_decoder_set_*() Chris@2: * functions for each setting's default. Chris@2: * Chris@2: * \retval FLAC__StreamDecoder* Chris@2: * \c NULL if there was an error allocating memory, else the new instance. Chris@2: */ Chris@2: FLAC_API FLAC__StreamDecoder *FLAC__stream_decoder_new(void); Chris@2: Chris@2: /** Free a decoder instance. Deletes the object pointed to by \a decoder. Chris@2: * Chris@2: * \param decoder A pointer to an existing decoder. Chris@2: * \assert Chris@2: * \code decoder != NULL \endcode Chris@2: */ Chris@2: FLAC_API void FLAC__stream_decoder_delete(FLAC__StreamDecoder *decoder); Chris@2: Chris@2: Chris@2: /*********************************************************************** Chris@2: * Chris@2: * Public class method prototypes Chris@2: * Chris@2: ***********************************************************************/ Chris@2: Chris@2: /** Set the serial number for the FLAC stream within the Ogg container. Chris@2: * The default behavior is to use the serial number of the first Ogg Chris@2: * page. Setting a serial number here will explicitly specify which Chris@2: * stream is to be decoded. Chris@2: * Chris@2: * \note Chris@2: * This does not need to be set for native FLAC decoding. Chris@2: * Chris@2: * \default \c use serial number of first page Chris@2: * \param decoder A decoder instance to set. Chris@2: * \param serial_number See above. Chris@2: * \assert Chris@2: * \code decoder != NULL \endcode Chris@2: * \retval FLAC__bool Chris@2: * \c false if the decoder is already initialized, else \c true. Chris@2: */ Chris@2: FLAC_API FLAC__bool FLAC__stream_decoder_set_ogg_serial_number(FLAC__StreamDecoder *decoder, long serial_number); Chris@2: Chris@2: /** Set the "MD5 signature checking" flag. If \c true, the decoder will Chris@2: * compute the MD5 signature of the unencoded audio data while decoding Chris@2: * and compare it to the signature from the STREAMINFO block, if it Chris@2: * exists, during FLAC__stream_decoder_finish(). Chris@2: * Chris@2: * MD5 signature checking will be turned off (until the next Chris@2: * FLAC__stream_decoder_reset()) if there is no signature in the Chris@2: * STREAMINFO block or when a seek is attempted. Chris@2: * Chris@2: * Clients that do not use the MD5 check should leave this off to speed Chris@2: * up decoding. Chris@2: * Chris@2: * \default \c false Chris@2: * \param decoder A decoder instance to set. Chris@2: * \param value Flag value (see above). Chris@2: * \assert Chris@2: * \code decoder != NULL \endcode Chris@2: * \retval FLAC__bool Chris@2: * \c false if the decoder is already initialized, else \c true. Chris@2: */ Chris@2: FLAC_API FLAC__bool FLAC__stream_decoder_set_md5_checking(FLAC__StreamDecoder *decoder, FLAC__bool value); Chris@2: Chris@2: /** Direct the decoder to pass on all metadata blocks of type \a type. Chris@2: * Chris@2: * \default By default, only the \c STREAMINFO block is returned via the Chris@2: * metadata callback. Chris@2: * \param decoder A decoder instance to set. Chris@2: * \param type See above. Chris@2: * \assert Chris@2: * \code decoder != NULL \endcode Chris@2: * \a type is valid Chris@2: * \retval FLAC__bool Chris@2: * \c false if the decoder is already initialized, else \c true. Chris@2: */ Chris@2: FLAC_API FLAC__bool FLAC__stream_decoder_set_metadata_respond(FLAC__StreamDecoder *decoder, FLAC__MetadataType type); Chris@2: Chris@2: /** Direct the decoder to pass on all APPLICATION metadata blocks of the Chris@2: * given \a id. Chris@2: * Chris@2: * \default By default, only the \c STREAMINFO block is returned via the Chris@2: * metadata callback. Chris@2: * \param decoder A decoder instance to set. Chris@2: * \param id See above. Chris@2: * \assert Chris@2: * \code decoder != NULL \endcode Chris@2: * \code id != NULL \endcode Chris@2: * \retval FLAC__bool Chris@2: * \c false if the decoder is already initialized, else \c true. Chris@2: */ Chris@2: FLAC_API FLAC__bool FLAC__stream_decoder_set_metadata_respond_application(FLAC__StreamDecoder *decoder, const FLAC__byte id[4]); Chris@2: Chris@2: /** Direct the decoder to pass on all metadata blocks of any type. Chris@2: * Chris@2: * \default By default, only the \c STREAMINFO block is returned via the Chris@2: * metadata callback. Chris@2: * \param decoder A decoder instance to set. Chris@2: * \assert Chris@2: * \code decoder != NULL \endcode Chris@2: * \retval FLAC__bool Chris@2: * \c false if the decoder is already initialized, else \c true. Chris@2: */ Chris@2: FLAC_API FLAC__bool FLAC__stream_decoder_set_metadata_respond_all(FLAC__StreamDecoder *decoder); Chris@2: Chris@2: /** Direct the decoder to filter out all metadata blocks of type \a type. Chris@2: * Chris@2: * \default By default, only the \c STREAMINFO block is returned via the Chris@2: * metadata callback. Chris@2: * \param decoder A decoder instance to set. Chris@2: * \param type See above. Chris@2: * \assert Chris@2: * \code decoder != NULL \endcode Chris@2: * \a type is valid Chris@2: * \retval FLAC__bool Chris@2: * \c false if the decoder is already initialized, else \c true. Chris@2: */ Chris@2: FLAC_API FLAC__bool FLAC__stream_decoder_set_metadata_ignore(FLAC__StreamDecoder *decoder, FLAC__MetadataType type); Chris@2: Chris@2: /** Direct the decoder to filter out all APPLICATION metadata blocks of Chris@2: * the given \a id. Chris@2: * Chris@2: * \default By default, only the \c STREAMINFO block is returned via the Chris@2: * metadata callback. Chris@2: * \param decoder A decoder instance to set. Chris@2: * \param id See above. Chris@2: * \assert Chris@2: * \code decoder != NULL \endcode Chris@2: * \code id != NULL \endcode Chris@2: * \retval FLAC__bool Chris@2: * \c false if the decoder is already initialized, else \c true. Chris@2: */ Chris@2: FLAC_API FLAC__bool FLAC__stream_decoder_set_metadata_ignore_application(FLAC__StreamDecoder *decoder, const FLAC__byte id[4]); Chris@2: Chris@2: /** Direct the decoder to filter out all metadata blocks of any type. Chris@2: * Chris@2: * \default By default, only the \c STREAMINFO block is returned via the Chris@2: * metadata callback. Chris@2: * \param decoder A decoder instance to set. Chris@2: * \assert Chris@2: * \code decoder != NULL \endcode Chris@2: * \retval FLAC__bool Chris@2: * \c false if the decoder is already initialized, else \c true. Chris@2: */ Chris@2: FLAC_API FLAC__bool FLAC__stream_decoder_set_metadata_ignore_all(FLAC__StreamDecoder *decoder); Chris@2: Chris@2: /** Get the current decoder state. Chris@2: * Chris@2: * \param decoder A decoder instance to query. Chris@2: * \assert Chris@2: * \code decoder != NULL \endcode Chris@2: * \retval FLAC__StreamDecoderState Chris@2: * The current decoder state. Chris@2: */ Chris@2: FLAC_API FLAC__StreamDecoderState FLAC__stream_decoder_get_state(const FLAC__StreamDecoder *decoder); Chris@2: Chris@2: /** Get the current decoder state as a C string. Chris@2: * Chris@2: * \param decoder A decoder instance to query. Chris@2: * \assert Chris@2: * \code decoder != NULL \endcode Chris@2: * \retval const char * Chris@2: * The decoder state as a C string. Do not modify the contents. Chris@2: */ Chris@2: FLAC_API const char *FLAC__stream_decoder_get_resolved_state_string(const FLAC__StreamDecoder *decoder); Chris@2: Chris@2: /** Get the "MD5 signature checking" flag. Chris@2: * This is the value of the setting, not whether or not the decoder is Chris@2: * currently checking the MD5 (remember, it can be turned off automatically Chris@2: * by a seek). When the decoder is reset the flag will be restored to the Chris@2: * value returned by this function. Chris@2: * Chris@2: * \param decoder A decoder instance to query. Chris@2: * \assert Chris@2: * \code decoder != NULL \endcode Chris@2: * \retval FLAC__bool Chris@2: * See above. Chris@2: */ Chris@2: FLAC_API FLAC__bool FLAC__stream_decoder_get_md5_checking(const FLAC__StreamDecoder *decoder); Chris@2: Chris@2: /** Get the total number of samples in the stream being decoded. Chris@2: * Will only be valid after decoding has started and will contain the Chris@2: * value from the \c STREAMINFO block. A value of \c 0 means "unknown". Chris@2: * Chris@2: * \param decoder A decoder instance to query. Chris@2: * \assert Chris@2: * \code decoder != NULL \endcode Chris@2: * \retval unsigned Chris@2: * See above. Chris@2: */ Chris@2: FLAC_API FLAC__uint64 FLAC__stream_decoder_get_total_samples(const FLAC__StreamDecoder *decoder); Chris@2: Chris@2: /** Get the current number of channels in the stream being decoded. Chris@2: * Will only be valid after decoding has started and will contain the Chris@2: * value from the most recently decoded frame header. Chris@2: * Chris@2: * \param decoder A decoder instance to query. Chris@2: * \assert Chris@2: * \code decoder != NULL \endcode Chris@2: * \retval unsigned Chris@2: * See above. Chris@2: */ Chris@2: FLAC_API unsigned FLAC__stream_decoder_get_channels(const FLAC__StreamDecoder *decoder); Chris@2: Chris@2: /** Get the current channel assignment in the stream being decoded. Chris@2: * Will only be valid after decoding has started and will contain the Chris@2: * value from the most recently decoded frame header. Chris@2: * Chris@2: * \param decoder A decoder instance to query. Chris@2: * \assert Chris@2: * \code decoder != NULL \endcode Chris@2: * \retval FLAC__ChannelAssignment Chris@2: * See above. Chris@2: */ Chris@2: FLAC_API FLAC__ChannelAssignment FLAC__stream_decoder_get_channel_assignment(const FLAC__StreamDecoder *decoder); Chris@2: Chris@2: /** Get the current sample resolution in the stream being decoded. Chris@2: * Will only be valid after decoding has started and will contain the Chris@2: * value from the most recently decoded frame header. Chris@2: * Chris@2: * \param decoder A decoder instance to query. Chris@2: * \assert Chris@2: * \code decoder != NULL \endcode Chris@2: * \retval unsigned Chris@2: * See above. Chris@2: */ Chris@2: FLAC_API unsigned FLAC__stream_decoder_get_bits_per_sample(const FLAC__StreamDecoder *decoder); Chris@2: Chris@2: /** Get the current sample rate in Hz of the stream being decoded. Chris@2: * Will only be valid after decoding has started and will contain the Chris@2: * value from the most recently decoded frame header. Chris@2: * Chris@2: * \param decoder A decoder instance to query. Chris@2: * \assert Chris@2: * \code decoder != NULL \endcode Chris@2: * \retval unsigned Chris@2: * See above. Chris@2: */ Chris@2: FLAC_API unsigned FLAC__stream_decoder_get_sample_rate(const FLAC__StreamDecoder *decoder); Chris@2: Chris@2: /** Get the current blocksize of the stream being decoded. Chris@2: * Will only be valid after decoding has started and will contain the Chris@2: * value from the most recently decoded frame header. Chris@2: * Chris@2: * \param decoder A decoder instance to query. Chris@2: * \assert Chris@2: * \code decoder != NULL \endcode Chris@2: * \retval unsigned Chris@2: * See above. Chris@2: */ Chris@2: FLAC_API unsigned FLAC__stream_decoder_get_blocksize(const FLAC__StreamDecoder *decoder); Chris@2: Chris@2: /** Returns the decoder's current read position within the stream. Chris@2: * The position is the byte offset from the start of the stream. Chris@2: * Bytes before this position have been fully decoded. Note that Chris@2: * there may still be undecoded bytes in the decoder's read FIFO. Chris@2: * The returned position is correct even after a seek. Chris@2: * Chris@2: * \warning This function currently only works for native FLAC, Chris@2: * not Ogg FLAC streams. Chris@2: * Chris@2: * \param decoder A decoder instance to query. Chris@2: * \param position Address at which to return the desired position. Chris@2: * \assert Chris@2: * \code decoder != NULL \endcode Chris@2: * \code position != NULL \endcode Chris@2: * \retval FLAC__bool Chris@2: * \c true if successful, \c false if the stream is not native FLAC, Chris@2: * or there was an error from the 'tell' callback or it returned Chris@2: * \c FLAC__STREAM_DECODER_TELL_STATUS_UNSUPPORTED. Chris@2: */ Chris@2: FLAC_API FLAC__bool FLAC__stream_decoder_get_decode_position(const FLAC__StreamDecoder *decoder, FLAC__uint64 *position); Chris@2: Chris@2: /** Initialize the decoder instance to decode native FLAC streams. Chris@2: * Chris@2: * This flavor of initialization sets up the decoder to decode from a Chris@2: * native FLAC stream. I/O is performed via callbacks to the client. Chris@2: * For decoding from a plain file via filename or open FILE*, Chris@2: * FLAC__stream_decoder_init_file() and FLAC__stream_decoder_init_FILE() Chris@2: * provide a simpler interface. Chris@2: * Chris@2: * This function should be called after FLAC__stream_decoder_new() and Chris@2: * FLAC__stream_decoder_set_*() but before any of the Chris@2: * FLAC__stream_decoder_process_*() functions. Will set and return the Chris@2: * decoder state, which will be FLAC__STREAM_DECODER_SEARCH_FOR_METADATA Chris@2: * if initialization succeeded. Chris@2: * Chris@2: * \param decoder An uninitialized decoder instance. Chris@2: * \param read_callback See FLAC__StreamDecoderReadCallback. This Chris@2: * pointer must not be \c NULL. Chris@2: * \param seek_callback See FLAC__StreamDecoderSeekCallback. This Chris@2: * pointer may be \c NULL if seeking is not Chris@2: * supported. If \a seek_callback is not \c NULL then a Chris@2: * \a tell_callback, \a length_callback, and \a eof_callback must also be supplied. Chris@2: * Alternatively, a dummy seek callback that just Chris@2: * returns \c FLAC__STREAM_DECODER_SEEK_STATUS_UNSUPPORTED Chris@2: * may also be supplied, all though this is slightly Chris@2: * less efficient for the decoder. Chris@2: * \param tell_callback See FLAC__StreamDecoderTellCallback. This Chris@2: * pointer may be \c NULL if not supported by the client. If Chris@2: * \a seek_callback is not \c NULL then a Chris@2: * \a tell_callback must also be supplied. Chris@2: * Alternatively, a dummy tell callback that just Chris@2: * returns \c FLAC__STREAM_DECODER_TELL_STATUS_UNSUPPORTED Chris@2: * may also be supplied, all though this is slightly Chris@2: * less efficient for the decoder. Chris@2: * \param length_callback See FLAC__StreamDecoderLengthCallback. This Chris@2: * pointer may be \c NULL if not supported by the client. If Chris@2: * \a seek_callback is not \c NULL then a Chris@2: * \a length_callback must also be supplied. Chris@2: * Alternatively, a dummy length callback that just Chris@2: * returns \c FLAC__STREAM_DECODER_LENGTH_STATUS_UNSUPPORTED Chris@2: * may also be supplied, all though this is slightly Chris@2: * less efficient for the decoder. Chris@2: * \param eof_callback See FLAC__StreamDecoderEofCallback. This Chris@2: * pointer may be \c NULL if not supported by the client. If Chris@2: * \a seek_callback is not \c NULL then a Chris@2: * \a eof_callback must also be supplied. Chris@2: * Alternatively, a dummy length callback that just Chris@2: * returns \c false Chris@2: * may also be supplied, all though this is slightly Chris@2: * less efficient for the decoder. Chris@2: * \param write_callback See FLAC__StreamDecoderWriteCallback. This Chris@2: * pointer must not be \c NULL. Chris@2: * \param metadata_callback See FLAC__StreamDecoderMetadataCallback. This Chris@2: * pointer may be \c NULL if the callback is not Chris@2: * desired. Chris@2: * \param error_callback See FLAC__StreamDecoderErrorCallback. This Chris@2: * pointer must not be \c NULL. Chris@2: * \param client_data This value will be supplied to callbacks in their Chris@2: * \a client_data argument. Chris@2: * \assert Chris@2: * \code decoder != NULL \endcode Chris@2: * \retval FLAC__StreamDecoderInitStatus Chris@2: * \c FLAC__STREAM_DECODER_INIT_STATUS_OK if initialization was successful; Chris@2: * see FLAC__StreamDecoderInitStatus for the meanings of other return values. Chris@2: */ Chris@2: FLAC_API FLAC__StreamDecoderInitStatus FLAC__stream_decoder_init_stream( Chris@2: FLAC__StreamDecoder *decoder, Chris@2: FLAC__StreamDecoderReadCallback read_callback, Chris@2: FLAC__StreamDecoderSeekCallback seek_callback, Chris@2: FLAC__StreamDecoderTellCallback tell_callback, Chris@2: FLAC__StreamDecoderLengthCallback length_callback, Chris@2: FLAC__StreamDecoderEofCallback eof_callback, Chris@2: FLAC__StreamDecoderWriteCallback write_callback, Chris@2: FLAC__StreamDecoderMetadataCallback metadata_callback, Chris@2: FLAC__StreamDecoderErrorCallback error_callback, Chris@2: void *client_data Chris@2: ); Chris@2: Chris@2: /** Initialize the decoder instance to decode Ogg FLAC streams. Chris@2: * Chris@2: * This flavor of initialization sets up the decoder to decode from a Chris@2: * FLAC stream in an Ogg container. I/O is performed via callbacks to the Chris@2: * client. For decoding from a plain file via filename or open FILE*, Chris@2: * FLAC__stream_decoder_init_ogg_file() and FLAC__stream_decoder_init_ogg_FILE() Chris@2: * provide a simpler interface. Chris@2: * Chris@2: * This function should be called after FLAC__stream_decoder_new() and Chris@2: * FLAC__stream_decoder_set_*() but before any of the Chris@2: * FLAC__stream_decoder_process_*() functions. Will set and return the Chris@2: * decoder state, which will be FLAC__STREAM_DECODER_SEARCH_FOR_METADATA Chris@2: * if initialization succeeded. Chris@2: * Chris@2: * \note Support for Ogg FLAC in the library is optional. If this Chris@2: * library has been built without support for Ogg FLAC, this function Chris@2: * will return \c FLAC__STREAM_DECODER_INIT_STATUS_UNSUPPORTED_CONTAINER. Chris@2: * Chris@2: * \param decoder An uninitialized decoder instance. Chris@2: * \param read_callback See FLAC__StreamDecoderReadCallback. This Chris@2: * pointer must not be \c NULL. Chris@2: * \param seek_callback See FLAC__StreamDecoderSeekCallback. This Chris@2: * pointer may be \c NULL if seeking is not Chris@2: * supported. If \a seek_callback is not \c NULL then a Chris@2: * \a tell_callback, \a length_callback, and \a eof_callback must also be supplied. Chris@2: * Alternatively, a dummy seek callback that just Chris@2: * returns \c FLAC__STREAM_DECODER_SEEK_STATUS_UNSUPPORTED Chris@2: * may also be supplied, all though this is slightly Chris@2: * less efficient for the decoder. Chris@2: * \param tell_callback See FLAC__StreamDecoderTellCallback. This Chris@2: * pointer may be \c NULL if not supported by the client. If Chris@2: * \a seek_callback is not \c NULL then a Chris@2: * \a tell_callback must also be supplied. Chris@2: * Alternatively, a dummy tell callback that just Chris@2: * returns \c FLAC__STREAM_DECODER_TELL_STATUS_UNSUPPORTED Chris@2: * may also be supplied, all though this is slightly Chris@2: * less efficient for the decoder. Chris@2: * \param length_callback See FLAC__StreamDecoderLengthCallback. This Chris@2: * pointer may be \c NULL if not supported by the client. If Chris@2: * \a seek_callback is not \c NULL then a Chris@2: * \a length_callback must also be supplied. Chris@2: * Alternatively, a dummy length callback that just Chris@2: * returns \c FLAC__STREAM_DECODER_LENGTH_STATUS_UNSUPPORTED Chris@2: * may also be supplied, all though this is slightly Chris@2: * less efficient for the decoder. Chris@2: * \param eof_callback See FLAC__StreamDecoderEofCallback. This Chris@2: * pointer may be \c NULL if not supported by the client. If Chris@2: * \a seek_callback is not \c NULL then a Chris@2: * \a eof_callback must also be supplied. Chris@2: * Alternatively, a dummy length callback that just Chris@2: * returns \c false Chris@2: * may also be supplied, all though this is slightly Chris@2: * less efficient for the decoder. Chris@2: * \param write_callback See FLAC__StreamDecoderWriteCallback. This Chris@2: * pointer must not be \c NULL. Chris@2: * \param metadata_callback See FLAC__StreamDecoderMetadataCallback. This Chris@2: * pointer may be \c NULL if the callback is not Chris@2: * desired. Chris@2: * \param error_callback See FLAC__StreamDecoderErrorCallback. This Chris@2: * pointer must not be \c NULL. Chris@2: * \param client_data This value will be supplied to callbacks in their Chris@2: * \a client_data argument. Chris@2: * \assert Chris@2: * \code decoder != NULL \endcode Chris@2: * \retval FLAC__StreamDecoderInitStatus Chris@2: * \c FLAC__STREAM_DECODER_INIT_STATUS_OK if initialization was successful; Chris@2: * see FLAC__StreamDecoderInitStatus for the meanings of other return values. Chris@2: */ Chris@2: FLAC_API FLAC__StreamDecoderInitStatus FLAC__stream_decoder_init_ogg_stream( Chris@2: FLAC__StreamDecoder *decoder, Chris@2: FLAC__StreamDecoderReadCallback read_callback, Chris@2: FLAC__StreamDecoderSeekCallback seek_callback, Chris@2: FLAC__StreamDecoderTellCallback tell_callback, Chris@2: FLAC__StreamDecoderLengthCallback length_callback, Chris@2: FLAC__StreamDecoderEofCallback eof_callback, Chris@2: FLAC__StreamDecoderWriteCallback write_callback, Chris@2: FLAC__StreamDecoderMetadataCallback metadata_callback, Chris@2: FLAC__StreamDecoderErrorCallback error_callback, Chris@2: void *client_data Chris@2: ); Chris@2: Chris@2: /** Initialize the decoder instance to decode native FLAC files. Chris@2: * Chris@2: * This flavor of initialization sets up the decoder to decode from a Chris@2: * plain native FLAC file. For non-stdio streams, you must use Chris@2: * FLAC__stream_decoder_init_stream() and provide callbacks for the I/O. Chris@2: * Chris@2: * This function should be called after FLAC__stream_decoder_new() and Chris@2: * FLAC__stream_decoder_set_*() but before any of the Chris@2: * FLAC__stream_decoder_process_*() functions. Will set and return the Chris@2: * decoder state, which will be FLAC__STREAM_DECODER_SEARCH_FOR_METADATA Chris@2: * if initialization succeeded. Chris@2: * Chris@2: * \param decoder An uninitialized decoder instance. Chris@2: * \param file An open FLAC file. The file should have been Chris@2: * opened with mode \c "rb" and rewound. The file Chris@2: * becomes owned by the decoder and should not be Chris@2: * manipulated by the client while decoding. Chris@2: * Unless \a file is \c stdin, it will be closed Chris@2: * when FLAC__stream_decoder_finish() is called. Chris@2: * Note however that seeking will not work when Chris@2: * decoding from \c stdout since it is not seekable. Chris@2: * \param write_callback See FLAC__StreamDecoderWriteCallback. This Chris@2: * pointer must not be \c NULL. Chris@2: * \param metadata_callback See FLAC__StreamDecoderMetadataCallback. This Chris@2: * pointer may be \c NULL if the callback is not Chris@2: * desired. Chris@2: * \param error_callback See FLAC__StreamDecoderErrorCallback. This Chris@2: * pointer must not be \c NULL. Chris@2: * \param client_data This value will be supplied to callbacks in their Chris@2: * \a client_data argument. Chris@2: * \assert Chris@2: * \code decoder != NULL \endcode Chris@2: * \code file != NULL \endcode Chris@2: * \retval FLAC__StreamDecoderInitStatus Chris@2: * \c FLAC__STREAM_DECODER_INIT_STATUS_OK if initialization was successful; Chris@2: * see FLAC__StreamDecoderInitStatus for the meanings of other return values. Chris@2: */ Chris@2: FLAC_API FLAC__StreamDecoderInitStatus FLAC__stream_decoder_init_FILE( Chris@2: FLAC__StreamDecoder *decoder, Chris@2: FILE *file, Chris@2: FLAC__StreamDecoderWriteCallback write_callback, Chris@2: FLAC__StreamDecoderMetadataCallback metadata_callback, Chris@2: FLAC__StreamDecoderErrorCallback error_callback, Chris@2: void *client_data Chris@2: ); Chris@2: Chris@2: /** Initialize the decoder instance to decode Ogg FLAC files. Chris@2: * Chris@2: * This flavor of initialization sets up the decoder to decode from a Chris@2: * plain Ogg FLAC file. For non-stdio streams, you must use Chris@2: * FLAC__stream_decoder_init_ogg_stream() and provide callbacks for the I/O. Chris@2: * Chris@2: * This function should be called after FLAC__stream_decoder_new() and Chris@2: * FLAC__stream_decoder_set_*() but before any of the Chris@2: * FLAC__stream_decoder_process_*() functions. Will set and return the Chris@2: * decoder state, which will be FLAC__STREAM_DECODER_SEARCH_FOR_METADATA Chris@2: * if initialization succeeded. Chris@2: * Chris@2: * \note Support for Ogg FLAC in the library is optional. If this Chris@2: * library has been built without support for Ogg FLAC, this function Chris@2: * will return \c FLAC__STREAM_DECODER_INIT_STATUS_UNSUPPORTED_CONTAINER. Chris@2: * Chris@2: * \param decoder An uninitialized decoder instance. Chris@2: * \param file An open FLAC file. The file should have been Chris@2: * opened with mode \c "rb" and rewound. The file Chris@2: * becomes owned by the decoder and should not be Chris@2: * manipulated by the client while decoding. Chris@2: * Unless \a file is \c stdin, it will be closed Chris@2: * when FLAC__stream_decoder_finish() is called. Chris@2: * Note however that seeking will not work when Chris@2: * decoding from \c stdout since it is not seekable. Chris@2: * \param write_callback See FLAC__StreamDecoderWriteCallback. This Chris@2: * pointer must not be \c NULL. Chris@2: * \param metadata_callback See FLAC__StreamDecoderMetadataCallback. This Chris@2: * pointer may be \c NULL if the callback is not Chris@2: * desired. Chris@2: * \param error_callback See FLAC__StreamDecoderErrorCallback. This Chris@2: * pointer must not be \c NULL. Chris@2: * \param client_data This value will be supplied to callbacks in their Chris@2: * \a client_data argument. Chris@2: * \assert Chris@2: * \code decoder != NULL \endcode Chris@2: * \code file != NULL \endcode Chris@2: * \retval FLAC__StreamDecoderInitStatus Chris@2: * \c FLAC__STREAM_DECODER_INIT_STATUS_OK if initialization was successful; Chris@2: * see FLAC__StreamDecoderInitStatus for the meanings of other return values. Chris@2: */ Chris@2: FLAC_API FLAC__StreamDecoderInitStatus FLAC__stream_decoder_init_ogg_FILE( Chris@2: FLAC__StreamDecoder *decoder, Chris@2: FILE *file, Chris@2: FLAC__StreamDecoderWriteCallback write_callback, Chris@2: FLAC__StreamDecoderMetadataCallback metadata_callback, Chris@2: FLAC__StreamDecoderErrorCallback error_callback, Chris@2: void *client_data Chris@2: ); Chris@2: Chris@2: /** Initialize the decoder instance to decode native FLAC files. Chris@2: * Chris@2: * This flavor of initialization sets up the decoder to decode from a plain Chris@2: * native FLAC file. If POSIX fopen() semantics are not sufficient, (for Chris@2: * example, with Unicode filenames on Windows), you must use Chris@2: * FLAC__stream_decoder_init_FILE(), or FLAC__stream_decoder_init_stream() Chris@2: * and provide callbacks for the I/O. Chris@2: * Chris@2: * This function should be called after FLAC__stream_decoder_new() and Chris@2: * FLAC__stream_decoder_set_*() but before any of the Chris@2: * FLAC__stream_decoder_process_*() functions. Will set and return the Chris@2: * decoder state, which will be FLAC__STREAM_DECODER_SEARCH_FOR_METADATA Chris@2: * if initialization succeeded. Chris@2: * Chris@2: * \param decoder An uninitialized decoder instance. Chris@2: * \param filename The name of the file to decode from. The file will Chris@2: * be opened with fopen(). Use \c NULL to decode from Chris@2: * \c stdin. Note that \c stdin is not seekable. Chris@2: * \param write_callback See FLAC__StreamDecoderWriteCallback. This Chris@2: * pointer must not be \c NULL. Chris@2: * \param metadata_callback See FLAC__StreamDecoderMetadataCallback. This Chris@2: * pointer may be \c NULL if the callback is not Chris@2: * desired. Chris@2: * \param error_callback See FLAC__StreamDecoderErrorCallback. This Chris@2: * pointer must not be \c NULL. Chris@2: * \param client_data This value will be supplied to callbacks in their Chris@2: * \a client_data argument. Chris@2: * \assert Chris@2: * \code decoder != NULL \endcode Chris@2: * \retval FLAC__StreamDecoderInitStatus Chris@2: * \c FLAC__STREAM_DECODER_INIT_STATUS_OK if initialization was successful; Chris@2: * see FLAC__StreamDecoderInitStatus for the meanings of other return values. Chris@2: */ Chris@2: FLAC_API FLAC__StreamDecoderInitStatus FLAC__stream_decoder_init_file( Chris@2: FLAC__StreamDecoder *decoder, Chris@2: const char *filename, Chris@2: FLAC__StreamDecoderWriteCallback write_callback, Chris@2: FLAC__StreamDecoderMetadataCallback metadata_callback, Chris@2: FLAC__StreamDecoderErrorCallback error_callback, Chris@2: void *client_data Chris@2: ); Chris@2: Chris@2: /** Initialize the decoder instance to decode Ogg FLAC files. Chris@2: * Chris@2: * This flavor of initialization sets up the decoder to decode from a plain Chris@2: * Ogg FLAC file. If POSIX fopen() semantics are not sufficient, (for Chris@2: * example, with Unicode filenames on Windows), you must use Chris@2: * FLAC__stream_decoder_init_ogg_FILE(), or FLAC__stream_decoder_init_ogg_stream() Chris@2: * and provide callbacks for the I/O. Chris@2: * Chris@2: * This function should be called after FLAC__stream_decoder_new() and Chris@2: * FLAC__stream_decoder_set_*() but before any of the Chris@2: * FLAC__stream_decoder_process_*() functions. Will set and return the Chris@2: * decoder state, which will be FLAC__STREAM_DECODER_SEARCH_FOR_METADATA Chris@2: * if initialization succeeded. Chris@2: * Chris@2: * \note Support for Ogg FLAC in the library is optional. If this Chris@2: * library has been built without support for Ogg FLAC, this function Chris@2: * will return \c FLAC__STREAM_DECODER_INIT_STATUS_UNSUPPORTED_CONTAINER. Chris@2: * Chris@2: * \param decoder An uninitialized decoder instance. Chris@2: * \param filename The name of the file to decode from. The file will Chris@2: * be opened with fopen(). Use \c NULL to decode from Chris@2: * \c stdin. Note that \c stdin is not seekable. Chris@2: * \param write_callback See FLAC__StreamDecoderWriteCallback. This Chris@2: * pointer must not be \c NULL. Chris@2: * \param metadata_callback See FLAC__StreamDecoderMetadataCallback. This Chris@2: * pointer may be \c NULL if the callback is not Chris@2: * desired. Chris@2: * \param error_callback See FLAC__StreamDecoderErrorCallback. This Chris@2: * pointer must not be \c NULL. Chris@2: * \param client_data This value will be supplied to callbacks in their Chris@2: * \a client_data argument. Chris@2: * \assert Chris@2: * \code decoder != NULL \endcode Chris@2: * \retval FLAC__StreamDecoderInitStatus Chris@2: * \c FLAC__STREAM_DECODER_INIT_STATUS_OK if initialization was successful; Chris@2: * see FLAC__StreamDecoderInitStatus for the meanings of other return values. Chris@2: */ Chris@2: FLAC_API FLAC__StreamDecoderInitStatus FLAC__stream_decoder_init_ogg_file( Chris@2: FLAC__StreamDecoder *decoder, Chris@2: const char *filename, Chris@2: FLAC__StreamDecoderWriteCallback write_callback, Chris@2: FLAC__StreamDecoderMetadataCallback metadata_callback, Chris@2: FLAC__StreamDecoderErrorCallback error_callback, Chris@2: void *client_data Chris@2: ); Chris@2: Chris@2: /** Finish the decoding process. Chris@2: * Flushes the decoding buffer, releases resources, resets the decoder Chris@2: * settings to their defaults, and returns the decoder state to Chris@2: * FLAC__STREAM_DECODER_UNINITIALIZED. Chris@2: * Chris@2: * In the event of a prematurely-terminated decode, it is not strictly Chris@2: * necessary to call this immediately before FLAC__stream_decoder_delete() Chris@2: * but it is good practice to match every FLAC__stream_decoder_init_*() Chris@2: * with a FLAC__stream_decoder_finish(). Chris@2: * Chris@2: * \param decoder An uninitialized decoder instance. Chris@2: * \assert Chris@2: * \code decoder != NULL \endcode Chris@2: * \retval FLAC__bool Chris@2: * \c false if MD5 checking is on AND a STREAMINFO block was available Chris@2: * AND the MD5 signature in the STREAMINFO block was non-zero AND the Chris@2: * signature does not match the one computed by the decoder; else Chris@2: * \c true. Chris@2: */ Chris@2: FLAC_API FLAC__bool FLAC__stream_decoder_finish(FLAC__StreamDecoder *decoder); Chris@2: Chris@2: /** Flush the stream input. Chris@2: * The decoder's input buffer will be cleared and the state set to Chris@2: * \c FLAC__STREAM_DECODER_SEARCH_FOR_FRAME_SYNC. This will also turn Chris@2: * off MD5 checking. Chris@2: * Chris@2: * \param decoder A decoder instance. Chris@2: * \assert Chris@2: * \code decoder != NULL \endcode Chris@2: * \retval FLAC__bool Chris@2: * \c true if successful, else \c false if a memory allocation Chris@2: * error occurs (in which case the state will be set to Chris@2: * \c FLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR). Chris@2: */ Chris@2: FLAC_API FLAC__bool FLAC__stream_decoder_flush(FLAC__StreamDecoder *decoder); Chris@2: Chris@2: /** Reset the decoding process. Chris@2: * The decoder's input buffer will be cleared and the state set to Chris@2: * \c FLAC__STREAM_DECODER_SEARCH_FOR_METADATA. This is similar to Chris@2: * FLAC__stream_decoder_finish() except that the settings are Chris@2: * preserved; there is no need to call FLAC__stream_decoder_init_*() Chris@2: * before decoding again. MD5 checking will be restored to its original Chris@2: * setting. Chris@2: * Chris@2: * If the decoder is seekable, or was initialized with Chris@2: * FLAC__stream_decoder_init*_FILE() or FLAC__stream_decoder_init*_file(), Chris@2: * the decoder will also attempt to seek to the beginning of the file. Chris@2: * If this rewind fails, this function will return \c false. It follows Chris@2: * that FLAC__stream_decoder_reset() cannot be used when decoding from Chris@2: * \c stdin. Chris@2: * Chris@2: * If the decoder was initialized with FLAC__stream_encoder_init*_stream() Chris@2: * and is not seekable (i.e. no seek callback was provided or the seek Chris@2: * callback returns \c FLAC__STREAM_DECODER_SEEK_STATUS_UNSUPPORTED), it Chris@2: * is the duty of the client to start feeding data from the beginning of Chris@2: * the stream on the next FLAC__stream_decoder_process() or Chris@2: * FLAC__stream_decoder_process_interleaved() call. Chris@2: * Chris@2: * \param decoder A decoder instance. Chris@2: * \assert Chris@2: * \code decoder != NULL \endcode Chris@2: * \retval FLAC__bool Chris@2: * \c true if successful, else \c false if a memory allocation occurs Chris@2: * (in which case the state will be set to Chris@2: * \c FLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR) or a seek error Chris@2: * occurs (the state will be unchanged). Chris@2: */ Chris@2: FLAC_API FLAC__bool FLAC__stream_decoder_reset(FLAC__StreamDecoder *decoder); Chris@2: Chris@2: /** Decode one metadata block or audio frame. Chris@2: * This version instructs the decoder to decode a either a single metadata Chris@2: * block or a single frame and stop, unless the callbacks return a fatal Chris@2: * error or the read callback returns Chris@2: * \c FLAC__STREAM_DECODER_READ_STATUS_END_OF_STREAM. Chris@2: * Chris@2: * As the decoder needs more input it will call the read callback. Chris@2: * Depending on what was decoded, the metadata or write callback will be Chris@2: * called with the decoded metadata block or audio frame. Chris@2: * Chris@2: * Unless there is a fatal read error or end of stream, this function Chris@2: * will return once one whole frame is decoded. In other words, if the Chris@2: * stream is not synchronized or points to a corrupt frame header, the Chris@2: * decoder will continue to try and resync until it gets to a valid Chris@2: * frame, then decode one frame, then return. If the decoder points to Chris@2: * a frame whose frame CRC in the frame footer does not match the Chris@2: * computed frame CRC, this function will issue a Chris@2: * FLAC__STREAM_DECODER_ERROR_STATUS_FRAME_CRC_MISMATCH error to the Chris@2: * error callback, and return, having decoded one complete, although Chris@2: * corrupt, frame. (Such corrupted frames are sent as silence of the Chris@2: * correct length to the write callback.) Chris@2: * Chris@2: * \param decoder An initialized decoder instance. Chris@2: * \assert Chris@2: * \code decoder != NULL \endcode Chris@2: * \retval FLAC__bool Chris@2: * \c false if any fatal read, write, or memory allocation error Chris@2: * occurred (meaning decoding must stop), else \c true; for more Chris@2: * information about the decoder, check the decoder state with Chris@2: * FLAC__stream_decoder_get_state(). Chris@2: */ Chris@2: FLAC_API FLAC__bool FLAC__stream_decoder_process_single(FLAC__StreamDecoder *decoder); Chris@2: Chris@2: /** Decode until the end of the metadata. Chris@2: * This version instructs the decoder to decode from the current position Chris@2: * and continue until all the metadata has been read, or until the Chris@2: * callbacks return a fatal error or the read callback returns Chris@2: * \c FLAC__STREAM_DECODER_READ_STATUS_END_OF_STREAM. Chris@2: * Chris@2: * As the decoder needs more input it will call the read callback. Chris@2: * As each metadata block is decoded, the metadata callback will be called Chris@2: * with the decoded metadata. Chris@2: * Chris@2: * \param decoder An initialized decoder instance. Chris@2: * \assert Chris@2: * \code decoder != NULL \endcode Chris@2: * \retval FLAC__bool Chris@2: * \c false if any fatal read, write, or memory allocation error Chris@2: * occurred (meaning decoding must stop), else \c true; for more Chris@2: * information about the decoder, check the decoder state with Chris@2: * FLAC__stream_decoder_get_state(). Chris@2: */ Chris@2: FLAC_API FLAC__bool FLAC__stream_decoder_process_until_end_of_metadata(FLAC__StreamDecoder *decoder); Chris@2: Chris@2: /** Decode until the end of the stream. Chris@2: * This version instructs the decoder to decode from the current position Chris@2: * and continue until the end of stream (the read callback returns Chris@2: * \c FLAC__STREAM_DECODER_READ_STATUS_END_OF_STREAM), or until the Chris@2: * callbacks return a fatal error. Chris@2: * Chris@2: * As the decoder needs more input it will call the read callback. Chris@2: * As each metadata block and frame is decoded, the metadata or write Chris@2: * callback will be called with the decoded metadata or frame. Chris@2: * Chris@2: * \param decoder An initialized decoder instance. Chris@2: * \assert Chris@2: * \code decoder != NULL \endcode Chris@2: * \retval FLAC__bool Chris@2: * \c false if any fatal read, write, or memory allocation error Chris@2: * occurred (meaning decoding must stop), else \c true; for more Chris@2: * information about the decoder, check the decoder state with Chris@2: * FLAC__stream_decoder_get_state(). Chris@2: */ Chris@2: FLAC_API FLAC__bool FLAC__stream_decoder_process_until_end_of_stream(FLAC__StreamDecoder *decoder); Chris@2: Chris@2: /** Skip one audio frame. Chris@2: * This version instructs the decoder to 'skip' a single frame and stop, Chris@2: * unless the callbacks return a fatal error or the read callback returns Chris@2: * \c FLAC__STREAM_DECODER_READ_STATUS_END_OF_STREAM. Chris@2: * Chris@2: * The decoding flow is the same as what occurs when Chris@2: * FLAC__stream_decoder_process_single() is called to process an audio Chris@2: * frame, except that this function does not decode the parsed data into Chris@2: * PCM or call the write callback. The integrity of the frame is still Chris@2: * checked the same way as in the other process functions. Chris@2: * Chris@2: * This function will return once one whole frame is skipped, in the Chris@2: * same way that FLAC__stream_decoder_process_single() will return once Chris@2: * one whole frame is decoded. Chris@2: * Chris@2: * This function can be used in more quickly determining FLAC frame Chris@2: * boundaries when decoding of the actual data is not needed, for Chris@2: * example when an application is separating a FLAC stream into frames Chris@2: * for editing or storing in a container. To do this, the application Chris@2: * can use FLAC__stream_decoder_skip_single_frame() to quickly advance Chris@2: * to the next frame, then use Chris@2: * FLAC__stream_decoder_get_decode_position() to find the new frame Chris@2: * boundary. Chris@2: * Chris@2: * This function should only be called when the stream has advanced Chris@2: * past all the metadata, otherwise it will return \c false. Chris@2: * Chris@2: * \param decoder An initialized decoder instance not in a metadata Chris@2: * state. Chris@2: * \assert Chris@2: * \code decoder != NULL \endcode Chris@2: * \retval FLAC__bool Chris@2: * \c false if any fatal read, write, or memory allocation error Chris@2: * occurred (meaning decoding must stop), or if the decoder Chris@2: * is in the FLAC__STREAM_DECODER_SEARCH_FOR_METADATA or Chris@2: * FLAC__STREAM_DECODER_READ_METADATA state, else \c true; for more Chris@2: * information about the decoder, check the decoder state with Chris@2: * FLAC__stream_decoder_get_state(). Chris@2: */ Chris@2: FLAC_API FLAC__bool FLAC__stream_decoder_skip_single_frame(FLAC__StreamDecoder *decoder); Chris@2: Chris@2: /** Flush the input and seek to an absolute sample. Chris@2: * Decoding will resume at the given sample. Note that because of Chris@2: * this, the next write callback may contain a partial block. The Chris@2: * client must support seeking the input or this function will fail Chris@2: * and return \c false. Furthermore, if the decoder state is Chris@2: * \c FLAC__STREAM_DECODER_SEEK_ERROR, then the decoder must be flushed Chris@2: * with FLAC__stream_decoder_flush() or reset with Chris@2: * FLAC__stream_decoder_reset() before decoding can continue. Chris@2: * Chris@2: * \param decoder A decoder instance. Chris@2: * \param sample The target sample number to seek to. Chris@2: * \assert Chris@2: * \code decoder != NULL \endcode Chris@2: * \retval FLAC__bool Chris@2: * \c true if successful, else \c false. Chris@2: */ Chris@2: FLAC_API FLAC__bool FLAC__stream_decoder_seek_absolute(FLAC__StreamDecoder *decoder, FLAC__uint64 sample); Chris@2: Chris@2: /* \} */ Chris@2: Chris@2: #ifdef __cplusplus Chris@2: } Chris@2: #endif Chris@2: Chris@2: #endif