file_decoder.h
上传用户:wstnjxml
上传日期:2014-04-03
资源大小:7248k
文件大小:24k
源码类别:

Windows CE

开发平台:

C/C++

  1. /* libFLAC - Free Lossless Audio Codec library
  2.  * Copyright (C) 2000,2001,2002,2003,2004,2005  Josh Coalson
  3.  *
  4.  * Redistribution and use in source and binary forms, with or without
  5.  * modification, are permitted provided that the following conditions
  6.  * are met:
  7.  *
  8.  * - Redistributions of source code must retain the above copyright
  9.  * notice, this list of conditions and the following disclaimer.
  10.  *
  11.  * - Redistributions in binary form must reproduce the above copyright
  12.  * notice, this list of conditions and the following disclaimer in the
  13.  * documentation and/or other materials provided with the distribution.
  14.  *
  15.  * - Neither the name of the Xiph.org Foundation nor the names of its
  16.  * contributors may be used to endorse or promote products derived from
  17.  * this software without specific prior written permission.
  18.  *
  19.  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20.  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  21.  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  22.  * A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
  23.  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  24.  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  25.  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  26.  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  27.  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  28.  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  29.  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30.  */
  31. #ifndef FLAC__FILE_DECODER_H
  32. #define FLAC__FILE_DECODER_H
  33. #include "export.h"
  34. #include "seekable_stream_decoder.h"
  35. #ifdef __cplusplus
  36. extern "C" {
  37. #endif
  38. /** file include/FLAC/file_decoder.h
  39.  *
  40.  *  brief
  41.  *  This module contains the functions which implement the file
  42.  *  decoder.
  43.  *
  44.  *  See the detailed documentation in the
  45.  *  link flac_file_decoder file decoder endlink module.
  46.  */
  47. /** defgroup flac_file_decoder FLAC/file_decoder.h: file decoder interface
  48.  *  ingroup flac_decoder
  49.  *
  50.  *  brief
  51.  *  This module contains the functions which implement the file
  52.  *  decoder.
  53.  *
  54.  * The basic usage of this decoder is as follows:
  55.  * - The program creates an instance of a decoder using
  56.  *   FLAC__file_decoder_new().
  57.  * - The program overrides the default settings and sets callbacks for
  58.  *   writing, error reporting, and metadata reporting using
  59.  *   FLAC__file_decoder_set_*() functions.
  60.  * - The program initializes the instance to validate the settings and
  61.  *   prepare for decoding using FLAC__file_decoder_init().
  62.  * - The program calls the FLAC__file_decoder_process_*() functions
  63.  *   to decode data, which subsequently calls the callbacks.
  64.  * - The program finishes the decoding with FLAC__file_decoder_finish(),
  65.  *   which flushes the input and output and resets the decoder to the
  66.  *   uninitialized state.
  67.  * - The instance may be used again or deleted with
  68.  *   FLAC__file_decoder_delete().
  69.  *
  70.  * The file decoder is a trivial wrapper around the
  71.  * link flac_seekable_stream_decoder seekable stream decoder endlink
  72.  * meant to simplfy the process of decoding from a standard file.  The
  73.  * file decoder supplies all but the Write/Metadata/Error callbacks.
  74.  * The user needs only to provide the path to the file and the file
  75.  * decoder handles the rest.
  76.  *
  77.  * Like the seekable stream decoder, seeking is exposed through the
  78.  * FLAC__file_decoder_seek_absolute() method.  At any point after the file
  79.  * decoder has been initialized, the user can call this function to seek to
  80.  * an exact sample within the file.  Subsequently, the first time the write
  81.  * callback is called it will be passed a (possibly partial) block starting
  82.  * at that sample.
  83.  *
  84.  * The file decoder also inherits MD5 signature checking from the seekable
  85.  * stream decoder.  If this is turned on before initialization,
  86.  * FLAC__file_decoder_finish() will report when the decoded MD5 signature
  87.  * does not match the one stored in the STREAMINFO block.  MD5 checking is
  88.  * automatically turned off if there is no signature in the STREAMINFO
  89.  * block or when a seek is attempted.
  90.  *
  91.  * Make sure to read the detailed descriptions of the
  92.  * link flac_seekable_stream_decoder seekable stream decoder module endlink
  93.  * and link flac_stream_decoder stream decoder module endlink
  94.  * since the file decoder inherits much of its behavior from them.
  95.  *
  96.  * note
  97.  * The "set" functions may only be called when the decoder is in the
  98.  * state FLAC__FILE_DECODER_UNINITIALIZED, i.e. after
  99.  * FLAC__file_decoder_new() or FLAC__file_decoder_finish(), but
  100.  * before FLAC__file_decoder_init().  If this is the case they will
  101.  * return c true, otherwise c false.
  102.  *
  103.  * note
  104.  * FLAC__file_decoder_finish() resets all settings to the constructor
  105.  * defaults, including the callbacks.
  106.  *
  107.  * {
  108.  */
  109. /** State values for a FLAC__FileDecoder
  110.  *
  111.  *  The decoder's state can be obtained by calling FLAC__file_decoder_get_state().
  112.  */
  113. typedef enum {
  114. FLAC__FILE_DECODER_OK = 0,
  115. /**< The decoder is in the normal OK state. */
  116. FLAC__FILE_DECODER_END_OF_FILE,
  117. /**< The decoder has reached the end of the file. */
  118. FLAC__FILE_DECODER_ERROR_OPENING_FILE,
  119. /**< An error occurred opening the input file. */
  120. FLAC__FILE_DECODER_MEMORY_ALLOCATION_ERROR,
  121. /**< An error occurred allocating memory. */
  122. FLAC__FILE_DECODER_SEEK_ERROR,
  123. /**< An error occurred while seeking. */
  124. FLAC__FILE_DECODER_SEEKABLE_STREAM_DECODER_ERROR,
  125. /**< An error occurred in the underlying seekable stream decoder. */
  126. FLAC__FILE_DECODER_ALREADY_INITIALIZED,
  127. /**< FLAC__file_decoder_init() was called when the decoder was already
  128.  * initialized, usually because FLAC__file_decoder_finish() was not
  129.  * called.
  130.  */
  131. FLAC__FILE_DECODER_INVALID_CALLBACK,
  132. /**< FLAC__file_decoder_init() was called without all callbacks
  133.  * being set.
  134.  */
  135. FLAC__FILE_DECODER_UNINITIALIZED
  136. /**< The decoder is in the uninitialized state. */
  137. } FLAC__FileDecoderState;
  138. /** Maps a FLAC__FileDecoderState to a C string.
  139.  *
  140.  *  Using a FLAC__FileDecoderState as the index to this array
  141.  *  will give the string equivalent.  The contents should not be modified.
  142.  */
  143. extern FLAC_API const char * const FLAC__FileDecoderStateString[];
  144. /***********************************************************************
  145.  *
  146.  * class FLAC__FileDecoder : public FLAC__StreamDecoder
  147.  *
  148.  ***********************************************************************/
  149. struct FLAC__FileDecoderProtected;
  150. struct FLAC__FileDecoderPrivate;
  151. /** The opaque structure definition for the file decoder type.  See the
  152.  *  link flac_file_decoder file decoder module endlink for a detailed
  153.  *  description.
  154.  */
  155. typedef struct {
  156. struct FLAC__FileDecoderProtected *protected_; /* avoid the C++ keyword 'protected' */
  157. struct FLAC__FileDecoderPrivate *private_; /* avoid the C++ keyword 'private' */
  158. } FLAC__FileDecoder;
  159. /** Signature for the write callback.
  160.  *  See FLAC__file_decoder_set_write_callback()
  161.  *  and FLAC__SeekableStreamDecoderWriteCallback for more info.
  162.  *
  163.  * param  decoder  The decoder instance calling the callback.
  164.  * param  frame    The description of the decoded frame.
  165.  * param  buffer   An array of pointers to decoded channels of data.
  166.  * param  client_data  The callee's client data set through
  167.  *                      FLAC__file_decoder_set_client_data().
  168.  * retval FLAC__StreamDecoderWriteStatus
  169.  *    The callee's return status.
  170.  */
  171. typedef FLAC__StreamDecoderWriteStatus (*FLAC__FileDecoderWriteCallback)(const FLAC__FileDecoder *decoder, const FLAC__Frame *frame, const FLAC__int32 * const buffer[], void *client_data);
  172. /** Signature for the metadata callback.
  173.  *  See FLAC__file_decoder_set_metadata_callback()
  174.  *  and FLAC__SeekableStreamDecoderMetadataCallback for more info.
  175.  *
  176.  * param  decoder  The decoder instance calling the callback.
  177.  * param  metadata The decoded metadata block.
  178.  * param  client_data  The callee's client data set through
  179.  *                      FLAC__file_decoder_set_client_data().
  180.  */
  181. typedef void (*FLAC__FileDecoderMetadataCallback)(const FLAC__FileDecoder *decoder, const FLAC__StreamMetadata *metadata, void *client_data);
  182. /** Signature for the error callback.
  183.  *  See FLAC__file_decoder_set_error_callback()
  184.  *  and FLAC__SeekableStreamDecoderErrorCallback for more info.
  185.  *
  186.  * param  decoder  The decoder instance calling the callback.
  187.  * param  status   The error encountered by the decoder.
  188.  * param  client_data  The callee's client data set through
  189.  *                      FLAC__file_decoder_set_client_data().
  190.  */
  191. typedef void (*FLAC__FileDecoderErrorCallback)(const FLAC__FileDecoder *decoder, FLAC__StreamDecoderErrorStatus status, void *client_data);
  192. /***********************************************************************
  193.  *
  194.  * Class constructor/destructor
  195.  *
  196.  ***********************************************************************/
  197. /** Create a new file decoder instance.  The instance is created with
  198.  *  default settings; see the individual FLAC__file_decoder_set_*()
  199.  *  functions for each setting's default.
  200.  *
  201.  * retval FLAC__FileDecoder*
  202.  *    c NULL if there was an error allocating memory, else the new instance.
  203.  */
  204. FLAC_API FLAC__FileDecoder *FLAC__file_decoder_new();
  205. /** Free a decoder instance.  Deletes the object pointed to by a decoder.
  206.  *
  207.  * param decoder  A pointer to an existing decoder.
  208.  * assert
  209.  *    code decoder != NULL endcode
  210.  */
  211. FLAC_API void FLAC__file_decoder_delete(FLAC__FileDecoder *decoder);
  212. /***********************************************************************
  213.  *
  214.  * Public class method prototypes
  215.  *
  216.  ***********************************************************************/
  217. /** Set the "MD5 signature checking" flag.
  218.  *  This is inherited from FLAC__SeekableStreamDecoder; see
  219.  *  FLAC__seekable_stream_decoder_set_md5_checking().
  220.  *
  221.  * default c false
  222.  * param  decoder  A decoder instance to set.
  223.  * param  value    See above.
  224.  * assert
  225.  *    code decoder != NULL endcode
  226.  * retval FLAC__bool
  227.  *    c false if the decoder is already initialized, else c true.
  228.  */
  229. FLAC_API FLAC__bool FLAC__file_decoder_set_md5_checking(FLAC__FileDecoder *decoder, FLAC__bool value);
  230. /** Set the input file name to decode.
  231.  *
  232.  * default c "-"
  233.  * param  decoder  A decoder instance to set.
  234.  * param  value    The input file name, or "-" for c stdin.
  235.  * assert
  236.  *    code decoder != NULL endcode
  237.  *    code value != NULL endcode
  238.  * retval FLAC__bool
  239.  *    c false if the decoder is already initialized, or there was a memory
  240.  *    allocation error, else c true.
  241.  */
  242. FLAC_API FLAC__bool FLAC__file_decoder_set_filename(FLAC__FileDecoder *decoder, const char *value);
  243. /** Set the write callback.
  244.  *  This is inherited from FLAC__SeekableStreamDecoder; see
  245.  *  FLAC__seekable_stream_decoder_set_write_callback().
  246.  *
  247.  * note
  248.  * The callback is mandatory and must be set before initialization.
  249.  *
  250.  * default c NULL
  251.  * param  decoder  A decoder instance to set.
  252.  * param  value    See above.
  253.  * assert
  254.  *    code decoder != NULL endcode
  255.  *    code value != NULL endcode
  256.  * retval FLAC__bool
  257.  *    c false if the decoder is already initialized, else c true.
  258.  */
  259. FLAC_API FLAC__bool FLAC__file_decoder_set_write_callback(FLAC__FileDecoder *decoder, FLAC__FileDecoderWriteCallback value);
  260. /** Set the metadata callback.
  261.  *  This is inherited from FLAC__SeekableStreamDecoder; see
  262.  *  FLAC__seekable_stream_decoder_set_metadata_callback().
  263.  *
  264.  * note
  265.  * The callback is mandatory and must be set before initialization.
  266.  *
  267.  * default c NULL
  268.  * param  decoder  A decoder instance to set.
  269.  * param  value    See above.
  270.  * assert
  271.  *    code decoder != NULL endcode
  272.  *    code value != NULL endcode
  273.  * retval FLAC__bool
  274.  *    c false if the decoder is already initialized, else c true.
  275.  */
  276. FLAC_API FLAC__bool FLAC__file_decoder_set_metadata_callback(FLAC__FileDecoder *decoder, FLAC__FileDecoderMetadataCallback value);
  277. /** Set the error callback.
  278.  *  This is inherited from FLAC__SeekableStreamDecoder; see
  279.  *  FLAC__seekable_stream_decoder_set_error_callback().
  280.  *
  281.  * note
  282.  * The callback is mandatory and must be set before initialization.
  283.  *
  284.  * default c NULL
  285.  * param  decoder  A decoder instance to set.
  286.  * param  value    See above.
  287.  * assert
  288.  *    code decoder != NULL endcode
  289.  *    code value != NULL endcode
  290.  * retval FLAC__bool
  291.  *    c false if the decoder is already initialized, else c true.
  292.  */
  293. FLAC_API FLAC__bool FLAC__file_decoder_set_error_callback(FLAC__FileDecoder *decoder, FLAC__FileDecoderErrorCallback value);
  294. /** Set the client data to be passed back to callbacks.
  295.  *  This value will be supplied to callbacks in their a client_data
  296.  *  argument.
  297.  *
  298.  * default c NULL
  299.  * param  decoder  A decoder instance to set.
  300.  * param  value    See above.
  301.  * assert
  302.  *    code decoder != NULL endcode
  303.  * retval FLAC__bool
  304.  *    c false if the decoder is already initialized, else c true.
  305.  */
  306. FLAC_API FLAC__bool FLAC__file_decoder_set_client_data(FLAC__FileDecoder *decoder, void *value);
  307. /** This is inherited from FLAC__SeekableStreamDecoder; see
  308.  *  FLAC__seekable_stream_decoder_set_metadata_respond().
  309.  *
  310.  * default By default, only the c STREAMINFO block is returned via the
  311.  *          metadata callback.
  312.  * param  decoder  A decoder instance to set.
  313.  * param  type     See above.
  314.  * assert
  315.  *    code decoder != NULL endcode
  316.  *    a type is valid
  317.  * retval FLAC__bool
  318.  *    c false if the decoder is already initialized, else c true.
  319.  */
  320. FLAC_API FLAC__bool FLAC__file_decoder_set_metadata_respond(FLAC__FileDecoder *decoder, FLAC__MetadataType type);
  321. /** This is inherited from FLAC__SeekableStreamDecoder; see
  322.  *  FLAC__seekable_stream_decoder_set_metadata_respond_application().
  323.  *
  324.  * default By default, only the c STREAMINFO block is returned via the
  325.  *          metadata callback.
  326.  * param  decoder  A decoder instance to set.
  327.  * param  id       See above.
  328.  * assert
  329.  *    code decoder != NULL endcode
  330.  *    code id != NULL endcode
  331.  * retval FLAC__bool
  332.  *    c false if the decoder is already initialized, else c true.
  333.  */
  334. FLAC_API FLAC__bool FLAC__file_decoder_set_metadata_respond_application(FLAC__FileDecoder *decoder, const FLAC__byte id[4]);
  335. /** This is inherited from FLAC__SeekableStreamDecoder; see
  336.  *  FLAC__seekable_stream_decoder_set_metadata_respond_all().
  337.  *
  338.  * default By default, only the c STREAMINFO block is returned via the
  339.  *          metadata callback.
  340.  * param  decoder  A decoder instance to set.
  341.  * assert
  342.  *    code decoder != NULL endcode
  343.  * retval FLAC__bool
  344.  *    c false if the decoder is already initialized, else c true.
  345.  */
  346. FLAC_API FLAC__bool FLAC__file_decoder_set_metadata_respond_all(FLAC__FileDecoder *decoder);
  347. /** This is inherited from FLAC__SeekableStreamDecoder; see
  348.  *  FLAC__seekable_stream_decoder_set_metadata_ignore().
  349.  *
  350.  * default By default, only the c STREAMINFO block is returned via the
  351.  *          metadata callback.
  352.  * param  decoder  A decoder instance to set.
  353.  * param  type     See above.
  354.  * assert
  355.  *    code decoder != NULL endcode
  356.  *    a type is valid
  357.  * retval FLAC__bool
  358.  *    c false if the decoder is already initialized, else c true.
  359.  */
  360. FLAC_API FLAC__bool FLAC__file_decoder_set_metadata_ignore(FLAC__FileDecoder *decoder, FLAC__MetadataType type);
  361. /** This is inherited from FLAC__SeekableStreamDecoder; see
  362.  *  FLAC__seekable_stream_decoder_set_metadata_ignore_application().
  363.  *
  364.  * default By default, only the c STREAMINFO block is returned via the
  365.  *          metadata callback.
  366.  * param  decoder  A decoder instance to set.
  367.  * param  id       See above.
  368.  * assert
  369.  *    code decoder != NULL endcode
  370.  *    code id != NULL endcode
  371.  * retval FLAC__bool
  372.  *    c false if the decoder is already initialized, else c true.
  373.  */
  374. FLAC_API FLAC__bool FLAC__file_decoder_set_metadata_ignore_application(FLAC__FileDecoder *decoder, const FLAC__byte id[4]);
  375. /** This is inherited from FLAC__SeekableStreamDecoder; see
  376.  *  FLAC__seekable_stream_decoder_set_metadata_ignore_all().
  377.  *
  378.  * default By default, only the c STREAMINFO block is returned via the
  379.  *          metadata callback.
  380.  * param  decoder  A decoder instance to set.
  381.  * assert
  382.  *    code decoder != NULL endcode
  383.  * retval FLAC__bool
  384.  *    c false if the decoder is already initialized, else c true.
  385.  */
  386. FLAC_API FLAC__bool FLAC__file_decoder_set_metadata_ignore_all(FLAC__FileDecoder *decoder);
  387. /** Get the current decoder state.
  388.  *
  389.  * param  decoder  A decoder instance to query.
  390.  * assert
  391.  *    code decoder != NULL endcode
  392.  * retval FLAC__FileDecoderState
  393.  *    The current decoder state.
  394.  */
  395. FLAC_API FLAC__FileDecoderState FLAC__file_decoder_get_state(const FLAC__FileDecoder *decoder);
  396. /** Get the state of the underlying seekable stream decoder.
  397.  *  Useful when the file decoder state is
  398.  *  c FLAC__FILE_DECODER_SEEKABLE_STREAM_DECODER_ERROR.
  399.  *
  400.  * param  decoder  A decoder instance to query.
  401.  * assert
  402.  *    code decoder != NULL endcode
  403.  * retval FLAC__SeekableStreamDecoderState
  404.  *    The seekable stream decoder state.
  405.  */
  406. FLAC_API FLAC__SeekableStreamDecoderState FLAC__file_decoder_get_seekable_stream_decoder_state(const FLAC__FileDecoder *decoder);
  407. /** Get the state of the underlying stream decoder.
  408.  *  Useful when the file decoder state is
  409.  *  c FLAC__FILE_DECODER_SEEKABLE_STREAM_DECODER_ERROR and the seekable stream
  410.  *  decoder state is c FLAC__SEEKABLE_STREAM_DECODER_STREAM_DECODER_ERROR.
  411.  *
  412.  * param  decoder  A decoder instance to query.
  413.  * assert
  414.  *    code decoder != NULL endcode
  415.  * retval FLAC__StreamDecoderState
  416.  *    The seekable stream decoder state.
  417.  */
  418. FLAC_API FLAC__StreamDecoderState FLAC__file_decoder_get_stream_decoder_state(const FLAC__FileDecoder *decoder);
  419. /** Get the current decoder state as a C string.
  420.  *  This version automatically resolves
  421.  *  c FLAC__FILE_DECODER_SEEKABLE_STREAM_DECODER_ERROR by getting the
  422.  *  seekable stream decoder's state.
  423.  *
  424.  * param  decoder  A decoder instance to query.
  425.  * assert
  426.  *    code decoder != NULL endcode
  427.  * retval const char *
  428.  *    The decoder state as a C string.  Do not modify the contents.
  429.  */
  430. FLAC_API const char *FLAC__file_decoder_get_resolved_state_string(const FLAC__FileDecoder *decoder);
  431. /** Get the "MD5 signature checking" flag.
  432.  *  This is inherited from FLAC__SeekableStreamDecoder; see
  433.  *  FLAC__seekable_stream_decoder_get_md5_checking().
  434.  *
  435.  * param  decoder  A decoder instance to query.
  436.  * assert
  437.  *    code decoder != NULL endcode
  438.  * retval FLAC__bool
  439.  *    See above.
  440.  */
  441. FLAC_API FLAC__bool FLAC__file_decoder_get_md5_checking(const FLAC__FileDecoder *decoder);
  442. /** This is inherited from FLAC__SeekableStreamDecoder; see
  443.  *  FLAC__seekable_stream_decoder_get_channels().
  444.  *
  445.  * param  decoder  A decoder instance to query.
  446.  * assert
  447.  *    code decoder != NULL endcode
  448.  * retval unsigned
  449.  *    See above.
  450.  */
  451. FLAC_API unsigned FLAC__file_decoder_get_channels(const FLAC__FileDecoder *decoder);
  452. /** This is inherited from FLAC__SeekableStreamDecoder; see
  453.  *  FLAC__seekable_stream_decoder_get_channel_assignment().
  454.  *
  455.  * param  decoder  A decoder instance to query.
  456.  * assert
  457.  *    code decoder != NULL endcode
  458.  * retval FLAC__ChannelAssignment
  459.  *    See above.
  460.  */
  461. FLAC_API FLAC__ChannelAssignment FLAC__file_decoder_get_channel_assignment(const FLAC__FileDecoder *decoder);
  462. /** This is inherited from FLAC__SeekableStreamDecoder; see
  463.  *  FLAC__seekable_stream_decoder_get_bits_per_sample().
  464.  *
  465.  * param  decoder  A decoder instance to query.
  466.  * assert
  467.  *    code decoder != NULL endcode
  468.  * retval unsigned
  469.  *    See above.
  470.  */
  471. FLAC_API unsigned FLAC__file_decoder_get_bits_per_sample(const FLAC__FileDecoder *decoder);
  472. /** This is inherited from FLAC__SeekableStreamDecoder; see
  473.  *  FLAC__seekable_stream_decoder_get_sample_rate().
  474.  *
  475.  * param  decoder  A decoder instance to query.
  476.  * assert
  477.  *    code decoder != NULL endcode
  478.  * retval unsigned
  479.  *    See above.
  480.  */
  481. FLAC_API unsigned FLAC__file_decoder_get_sample_rate(const FLAC__FileDecoder *decoder);
  482. /** This is inherited from FLAC__SeekableStreamDecoder; see
  483.  *  FLAC__seekable_stream_decoder_get_blocksize().
  484.  *
  485.  * param  decoder  A decoder instance to query.
  486.  * assert
  487.  *    code decoder != NULL endcode
  488.  * retval unsigned
  489.  *    See above.
  490.  */
  491. FLAC_API unsigned FLAC__file_decoder_get_blocksize(const FLAC__FileDecoder *decoder);
  492. /** This is inherited from FLAC__SeekableStreamDecoder; see
  493.  *  FLAC__seekable_stream_decoder_get_decode_position().
  494.  *
  495.  * param  decoder   A decoder instance to query.
  496.  * param  position  Address at which to return the desired position.
  497.  * assert
  498.  *    code decoder != NULL endcode
  499.  *    code position != NULL endcode
  500.  * retval FLAC__bool
  501.  *    c true if successful, c false if there was an error from
  502.  *    the 'tell' callback.
  503.  */
  504. FLAC_API FLAC__bool FLAC__file_decoder_get_decode_position(const FLAC__FileDecoder *decoder, FLAC__uint64 *position);
  505. /** Initialize the decoder instance.
  506.  *  Should be called after FLAC__file_decoder_new() and
  507.  *  FLAC__file_decoder_set_*() but before any of the
  508.  *  FLAC__file_decoder_process_*() functions.  Will set and return
  509.  *  the decoder state, which will be FLAC__FILE_DECODER_OK if
  510.  *  initialization succeeded.
  511.  *
  512.  * param  decoder  An uninitialized decoder instance.
  513.  * assert
  514.  *    code decoder != NULL endcode
  515.  * retval FLAC__FileDecoderState
  516.  *    c FLAC__FILE_DECODER_OK if initialization was successful; see
  517.  *    FLAC__FileDecoderState for the meanings of other return values.
  518.  */
  519. FLAC_API FLAC__FileDecoderState FLAC__file_decoder_init(FLAC__FileDecoder *decoder);
  520. /** Finish the decoding process.
  521.  *  Flushes the decoding buffer, releases resources, resets the decoder
  522.  *  settings to their defaults, and returns the decoder state to
  523.  *  FLAC__FILE_DECODER_UNINITIALIZED.
  524.  *
  525.  *  In the event of a prematurely-terminated decode, it is not strictly
  526.  *  necessary to call this immediately before FLAC__file_decoder_delete()
  527.  *  but it is good practice to match every FLAC__file_decoder_init() with
  528.  *  a FLAC__file_decoder_finish().
  529.  *
  530.  * param  decoder  An uninitialized decoder instance.
  531.  * assert
  532.  *    code decoder != NULL endcode
  533.  * retval FLAC__bool
  534.  *    c false if MD5 checking is on AND a STREAMINFO block was available
  535.  *    AND the MD5 signature in the STREAMINFO block was non-zero AND the
  536.  *    signature does not match the one computed by the decoder; else
  537.  *    c true.
  538.  */
  539. FLAC_API FLAC__bool FLAC__file_decoder_finish(FLAC__FileDecoder *decoder);
  540. /** This is inherited from FLAC__SeekableStreamDecoder; see
  541.  *  FLAC__seekable_stream_decoder_process_single().
  542.  *
  543.  * param  decoder  A decoder instance.
  544.  * assert
  545.  *    code decoder != NULL endcode
  546.  * retval FLAC__bool
  547.  *    See above.
  548.  */
  549. FLAC_API FLAC__bool FLAC__file_decoder_process_single(FLAC__FileDecoder *decoder);
  550. /** This is inherited from FLAC__SeekableStreamDecoder; see
  551.  *  FLAC__seekable_stream_decoder_process_until_end_of_metadata().
  552.  *
  553.  * param  decoder  A decoder instance.
  554.  * assert
  555.  *    code decoder != NULL endcode
  556.  * retval FLAC__bool
  557.  *    See above.
  558.  */
  559. FLAC_API FLAC__bool FLAC__file_decoder_process_until_end_of_metadata(FLAC__FileDecoder *decoder);
  560. /** This is inherited from FLAC__SeekableStreamDecoder; see
  561.  *  FLAC__seekable_stream_decoder_process_until_end_of_stream().
  562.  *
  563.  * param  decoder  A decoder instance.
  564.  * assert
  565.  *    code decoder != NULL endcode
  566.  * retval FLAC__bool
  567.  *    See above.
  568.  */
  569. FLAC_API FLAC__bool FLAC__file_decoder_process_until_end_of_file(FLAC__FileDecoder *decoder);
  570. /** This is inherited from FLAC__SeekableStreamDecoder; see
  571.  *  FLAC__seekable_stream_decoder_skip_single_frame().
  572.  *
  573.  * param  decoder  A decoder instance.
  574.  * assert
  575.  *    code decoder != NULL endcode
  576.  * retval FLAC__bool
  577.  *    See above.
  578.  */
  579. FLAC_API FLAC__bool FLAC__file_decoder_skip_single_frame(FLAC__FileDecoder *decoder);
  580. /** Flush the input and seek to an absolute sample.
  581.  *  This is inherited from FLAC__SeekableStreamDecoder; see
  582.  *  FLAC__seekable_stream_decoder_seek_absolute().
  583.  *
  584.  * param  decoder  A decoder instance.
  585.  * param  sample   The target sample number to seek to.
  586.  * assert
  587.  *    code decoder != NULL endcode
  588.  * retval FLAC__bool
  589.  *    c true if successful, else c false.
  590.  */
  591. FLAC_API FLAC__bool FLAC__file_decoder_seek_absolute(FLAC__FileDecoder *decoder, FLAC__uint64 sample);
  592. /* } */
  593. #ifdef __cplusplus
  594. }
  595. #endif
  596. #endif