~ubuntu-branches/ubuntu/raring/flac/raring

<a class="qindex" href="index.html">Main Page</a>   <a class="qindex" href="modules.html">Modules</a>   <a class="qindex" href="hierarchy.html">Class Hierarchy</a>   <a class="qindex" href="classes.html">Alphabetical List</a>   <a class="qindex" href="annotated.html">Compound List</a>   <a class="qindex" href="files.html">File List</a>   <a class="qindex" href="functions.html">Compound Members</a>   <a class="qindex" href="globals.html">File Members</a>   </center>

<hr><h1>FLAC/seekable_stream_decoder.h: seekable stream decoder interface<br>

<small>

[<a class="el" href="group__flac__decoder.html">FLAC/_decoder.h: decoder interfaces</a>]</small>

</h1>This module contains the functions which implement the seekable stream decoder.

<tr><td colspan=2><br><h2>Compounds</h2></td></tr>

<tr><td nowrap align=right valign=top>struct  </td><td valign=bottom><a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a></td></tr>

<tr><td colspan=2><br><h2>Typedefs</h2></td></tr>

<tr><td nowrap align=right valign=top>typedef <a class="el" href="group__flac__seekable__stream__decoder.html#a51">FLAC__SeekableStreamDecoderReadStatus</a>(* </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__decoder.html#a5">FLAC__SeekableStreamDecoderReadCallback</a> )(const <a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> *decoder, FLAC__byte buffer[], unsigned *bytes, void *client_data)</td></tr>

<tr><td nowrap align=right valign=top>typedef <a class="el" href="group__flac__seekable__stream__decoder.html#a52">FLAC__SeekableStreamDecoderSeekStatus</a>(* </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__decoder.html#a6">FLAC__SeekableStreamDecoderSeekCallback</a> )(const <a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> *decoder, FLAC__uint64 absolute_byte_offset, void *client_data)</td></tr>

<tr><td nowrap align=right valign=top>typedef <a class="el" href="group__flac__seekable__stream__decoder.html#a53">FLAC__SeekableStreamDecoderTellStatus</a>(* </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__decoder.html#a7">FLAC__SeekableStreamDecoderTellCallback</a> )(const <a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> *decoder, FLAC__uint64 *absolute_byte_offset, void *client_data)</td></tr>

<tr><td nowrap align=right valign=top>typedef <a class="el" href="group__flac__seekable__stream__decoder.html#a54">FLAC__SeekableStreamDecoderLengthStatus</a>(* </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__decoder.html#a8">FLAC__SeekableStreamDecoderLengthCallback</a> )(const <a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> *decoder, FLAC__uint64 *stream_length, void *client_data)</td></tr>

<tr><td nowrap align=right valign=top>typedef FLAC__bool(* </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__decoder.html#a9">FLAC__SeekableStreamDecoderEofCallback</a> )(const <a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> *decoder, void *client_data)</td></tr>

<tr><td nowrap align=right valign=top>typedef <a class="el" href="group__flac__stream__decoder.html#a38">FLAC__StreamDecoderWriteStatus</a>(* </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__decoder.html#a10">FLAC__SeekableStreamDecoderWriteCallback</a> )(const <a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> *decoder, const <a class="el" href="structFLAC____Frame.html">FLAC__Frame</a> *frame, const FLAC__int32 *const buffer[], void *client_data)</td></tr>

<tr><td nowrap align=right valign=top>typedef void(* </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__decoder.html#a11">FLAC__SeekableStreamDecoderMetadataCallback</a> )(const <a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> *decoder, const <a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> *metadata, void *client_data)</td></tr>

<tr><td nowrap align=right valign=top>typedef void(* </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__decoder.html#a12">FLAC__SeekableStreamDecoderErrorCallback</a> )(const <a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> *decoder, <a class="el" href="group__flac__stream__decoder.html#a39">FLAC__StreamDecoderErrorStatus</a> status, void *client_data)</td></tr>

<tr><td colspan=2><br><h2>Enumerations</h2></td></tr>

<tr><td nowrap align=right valign=top>enum  </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__decoder.html#a50">FLAC__SeekableStreamDecoderState</a> { <br>

  <a class="el" href="group__flac__seekable__stream__decoder.html#a50a13">FLAC__SEEKABLE_STREAM_DECODER_OK</a> = 0,

<a class="el" href="group__flac__seekable__stream__decoder.html#a50a14">FLAC__SEEKABLE_STREAM_DECODER_SEEKING</a>,

<a class="el" href="group__flac__seekable__stream__decoder.html#a50a15">FLAC__SEEKABLE_STREAM_DECODER_END_OF_STREAM</a>,

<a class="el" href="group__flac__seekable__stream__decoder.html#a50a16">FLAC__SEEKABLE_STREAM_DECODER_MEMORY_ALLOCATION_ERROR</a>,

<br>

  <a class="el" href="group__flac__seekable__stream__decoder.html#a50a17">FLAC__SEEKABLE_STREAM_DECODER_STREAM_DECODER_ERROR</a>,

<a class="el" href="group__flac__seekable__stream__decoder.html#a50a18">FLAC__SEEKABLE_STREAM_DECODER_READ_ERROR</a>,

<a class="el" href="group__flac__seekable__stream__decoder.html#a50a19">FLAC__SEEKABLE_STREAM_DECODER_SEEK_ERROR</a>,

<a class="el" href="group__flac__seekable__stream__decoder.html#a50a20">FLAC__SEEKABLE_STREAM_DECODER_ALREADY_INITIALIZED</a>,

<br>

  <a class="el" href="group__flac__seekable__stream__decoder.html#a50a21">FLAC__SEEKABLE_STREAM_DECODER_INVALID_CALLBACK</a>,

<a class="el" href="group__flac__seekable__stream__decoder.html#a50a22">FLAC__SEEKABLE_STREAM_DECODER_UNINITIALIZED</a>

<br>

}</td></tr>

<tr><td nowrap align=right valign=top>enum  </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__decoder.html#a51">FLAC__SeekableStreamDecoderReadStatus</a> { <a class="el" href="group__flac__seekable__stream__decoder.html#a51a23">FLAC__SEEKABLE_STREAM_DECODER_READ_STATUS_OK</a>,

<a class="el" href="group__flac__seekable__stream__decoder.html#a51a24">FLAC__SEEKABLE_STREAM_DECODER_READ_STATUS_ERROR</a>

}</td></tr>

<tr><td nowrap align=right valign=top>enum  </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__decoder.html#a52">FLAC__SeekableStreamDecoderSeekStatus</a> { <a class="el" href="group__flac__seekable__stream__decoder.html#a52a25">FLAC__SEEKABLE_STREAM_DECODER_SEEK_STATUS_OK</a>,

<a class="el" href="group__flac__seekable__stream__decoder.html#a52a26">FLAC__SEEKABLE_STREAM_DECODER_SEEK_STATUS_ERROR</a>

}</td></tr>

<tr><td nowrap align=right valign=top>enum  </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__decoder.html#a53">FLAC__SeekableStreamDecoderTellStatus</a> { <a class="el" href="group__flac__seekable__stream__decoder.html#a53a27">FLAC__SEEKABLE_STREAM_DECODER_TELL_STATUS_OK</a>,

<a class="el" href="group__flac__seekable__stream__decoder.html#a53a28">FLAC__SEEKABLE_STREAM_DECODER_TELL_STATUS_ERROR</a>

}</td></tr>

<tr><td nowrap align=right valign=top>enum  </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__decoder.html#a54">FLAC__SeekableStreamDecoderLengthStatus</a> { <a class="el" href="group__flac__seekable__stream__decoder.html#a54a29">FLAC__SEEKABLE_STREAM_DECODER_LENGTH_STATUS_OK</a>,

<a class="el" href="group__flac__seekable__stream__decoder.html#a54a30">FLAC__SEEKABLE_STREAM_DECODER_LENGTH_STATUS_ERROR</a>

}</td></tr>

<tr><td colspan=2><br><h2>Functions</h2></td></tr>

<tr><td nowrap align=right valign=top><a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> * </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__decoder.html#a13">FLAC__seekable_stream_decoder_new</a> ()</td></tr>

<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__decoder.html#a14">FLAC__seekable_stream_decoder_delete</a> (<a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> *decoder)</td></tr>

<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__decoder.html#a15">FLAC__seekable_stream_decoder_set_md5_checking</a> (<a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> *decoder, FLAC__bool value)</td></tr>

<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__decoder.html#a16">FLAC__seekable_stream_decoder_set_read_callback</a> (<a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> *decoder, <a class="el" href="group__flac__seekable__stream__decoder.html#a5">FLAC__SeekableStreamDecoderReadCallback</a> value)</td></tr>

<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__decoder.html#a17">FLAC__seekable_stream_decoder_set_seek_callback</a> (<a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> *decoder, <a class="el" href="group__flac__seekable__stream__decoder.html#a6">FLAC__SeekableStreamDecoderSeekCallback</a> value)</td></tr>

<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__decoder.html#a18">FLAC__seekable_stream_decoder_set_tell_callback</a> (<a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> *decoder, <a class="el" href="group__flac__seekable__stream__decoder.html#a7">FLAC__SeekableStreamDecoderTellCallback</a> value)</td></tr>

<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__decoder.html#a19">FLAC__seekable_stream_decoder_set_length_callback</a> (<a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> *decoder, <a class="el" href="group__flac__seekable__stream__decoder.html#a8">FLAC__SeekableStreamDecoderLengthCallback</a> value)</td></tr>

<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__decoder.html#a20">FLAC__seekable_stream_decoder_set_eof_callback</a> (<a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> *decoder, <a class="el" href="group__flac__seekable__stream__decoder.html#a9">FLAC__SeekableStreamDecoderEofCallback</a> value)</td></tr>

<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__decoder.html#a21">FLAC__seekable_stream_decoder_set_write_callback</a> (<a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> *decoder, <a class="el" href="group__flac__seekable__stream__decoder.html#a10">FLAC__SeekableStreamDecoderWriteCallback</a> value)</td></tr>

<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__decoder.html#a22">FLAC__seekable_stream_decoder_set_metadata_callback</a> (<a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> *decoder, <a class="el" href="group__flac__seekable__stream__decoder.html#a11">FLAC__SeekableStreamDecoderMetadataCallback</a> value)</td></tr>

<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__decoder.html#a23">FLAC__seekable_stream_decoder_set_error_callback</a> (<a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> *decoder, <a class="el" href="group__flac__seekable__stream__decoder.html#a12">FLAC__SeekableStreamDecoderErrorCallback</a> value)</td></tr>

<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__decoder.html#a24">FLAC__seekable_stream_decoder_set_client_data</a> (<a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> *decoder, void *value)</td></tr>

<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__decoder.html#a25">FLAC__seekable_stream_decoder_set_metadata_respond</a> (<a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> *decoder, <a class="el" href="group__flac__format.html#a97">FLAC__MetadataType</a> type)</td></tr>

<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__decoder.html#a26">FLAC__seekable_stream_decoder_set_metadata_respond_application</a> (<a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> *decoder, const FLAC__byte id[4])</td></tr>

<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__decoder.html#a27">FLAC__seekable_stream_decoder_set_metadata_respond_all</a> (<a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> *decoder)</td></tr>

<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__decoder.html#a28">FLAC__seekable_stream_decoder_set_metadata_ignore</a> (<a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> *decoder, <a class="el" href="group__flac__format.html#a97">FLAC__MetadataType</a> type)</td></tr>

<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__decoder.html#a29">FLAC__seekable_stream_decoder_set_metadata_ignore_application</a> (<a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> *decoder, const FLAC__byte id[4])</td></tr>

<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__decoder.html#a30">FLAC__seekable_stream_decoder_set_metadata_ignore_all</a> (<a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> *decoder)</td></tr>

<tr><td nowrap align=right valign=top><a class="el" href="group__flac__seekable__stream__decoder.html#a50">FLAC__SeekableStreamDecoderState</a> </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__decoder.html#a31">FLAC__seekable_stream_decoder_get_state</a> (const <a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> *decoder)</td></tr>

<tr><td nowrap align=right valign=top><a class="el" href="group__flac__stream__decoder.html#a36">FLAC__StreamDecoderState</a> </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__decoder.html#a32">FLAC__seekable_stream_decoder_get_stream_decoder_state</a> (const <a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> *decoder)</td></tr>

<tr><td nowrap align=right valign=top>const char * </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__decoder.html#a33">FLAC__seekable_stream_decoder_get_resolved_state_string</a> (const <a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> *decoder)</td></tr>

<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__decoder.html#a34">FLAC__seekable_stream_decoder_get_md5_checking</a> (const <a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> *decoder)</td></tr>

<tr><td nowrap align=right valign=top>unsigned </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__decoder.html#a35">FLAC__seekable_stream_decoder_get_channels</a> (const <a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> *decoder)</td></tr>

<tr><td nowrap align=right valign=top><a class="el" href="group__flac__format.html#a95">FLAC__ChannelAssignment</a> </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__decoder.html#a36">FLAC__seekable_stream_decoder_get_channel_assignment</a> (const <a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> *decoder)</td></tr>

<tr><td nowrap align=right valign=top>unsigned </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__decoder.html#a37">FLAC__seekable_stream_decoder_get_bits_per_sample</a> (const <a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> *decoder)</td></tr>

<tr><td nowrap align=right valign=top>unsigned </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__decoder.html#a38">FLAC__seekable_stream_decoder_get_sample_rate</a> (const <a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> *decoder)</td></tr>

<tr><td nowrap align=right valign=top>unsigned </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__decoder.html#a39">FLAC__seekable_stream_decoder_get_blocksize</a> (const <a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> *decoder)</td></tr>

<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__decoder.html#a40">FLAC__seekable_stream_decoder_get_decode_position</a> (const <a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> *decoder, FLAC__uint64 *position)</td></tr>

<tr><td nowrap align=right valign=top><a class="el" href="group__flac__seekable__stream__decoder.html#a50">FLAC__SeekableStreamDecoderState</a> </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__decoder.html#a41">FLAC__seekable_stream_decoder_init</a> (<a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> *decoder)</td></tr>

<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__decoder.html#a42">FLAC__seekable_stream_decoder_finish</a> (<a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> *decoder)</td></tr>

<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__decoder.html#a43">FLAC__seekable_stream_decoder_flush</a> (<a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> *decoder)</td></tr>

<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__decoder.html#a44">FLAC__seekable_stream_decoder_reset</a> (<a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> *decoder)</td></tr>

<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__decoder.html#a45">FLAC__seekable_stream_decoder_process_single</a> (<a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> *decoder)</td></tr>

<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__decoder.html#a46">FLAC__seekable_stream_decoder_process_until_end_of_metadata</a> (<a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> *decoder)</td></tr>

<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__decoder.html#a47">FLAC__seekable_stream_decoder_process_until_end_of_stream</a> (<a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> *decoder)</td></tr>

<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__decoder.html#a48">FLAC__seekable_stream_decoder_skip_single_frame</a> (<a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> *decoder)</td></tr>

<tr><td nowrap align=right valign=top>FLAC__bool </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__decoder.html#a49">FLAC__seekable_stream_decoder_seek_absolute</a> (<a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> *decoder, FLAC__uint64 sample)</td></tr>

<tr><td colspan=2><br><h2>Variables</h2></td></tr>

<tr><td nowrap align=right valign=top>const char *const </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__decoder.html#a0">FLAC__SeekableStreamDecoderStateString</a> []</td></tr>

<tr><td nowrap align=right valign=top>const char *const </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__decoder.html#a1">FLAC__SeekableStreamDecoderReadStatusString</a> []</td></tr>

<tr><td nowrap align=right valign=top>const char *const </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__decoder.html#a2">FLAC__SeekableStreamDecoderSeekStatusString</a> []</td></tr>

<tr><td nowrap align=right valign=top>const char *const </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__decoder.html#a3">FLAC__SeekableStreamDecoderTellStatusString</a> []</td></tr>

<tr><td nowrap align=right valign=top>const char *const </td><td valign=bottom><a class="el" href="group__flac__seekable__stream__decoder.html#a4">FLAC__SeekableStreamDecoderLengthStatusString</a> []</td></tr>

</table>

<hr><a name="_details"></a><h2>Detailed Description</h2>

This module contains the functions which implement the seekable stream decoder.

100

<p>

101

102

<p>

103

The basic usage of this decoder is as follows:<ul>

104

<li>The program creates an instance of a decoder using <a class="el" href="group__flac__seekable__stream__decoder.html#a13">FLAC__seekable_stream_decoder_new</a>().<li>The program overrides the default settings and sets callbacks for reading, writing, seeking, error reporting, and metadata reporting using FLAC__seekable_stream_decoder_set_*() functions.<li>The program initializes the instance to validate the settings and prepare for decoding using <a class="el" href="group__flac__seekable__stream__decoder.html#a41">FLAC__seekable_stream_decoder_init</a>().<li>The program calls the FLAC__seekable_stream_decoder_process_*() functions to decode data, which subsequently calls the callbacks.<li>The program finishes the decoding with <a class="el" href="group__flac__seekable__stream__decoder.html#a42">FLAC__seekable_stream_decoder_finish</a>(), which flushes the input and output and resets the decoder to the uninitialized state.<li>The instance may be used again or deleted with <a class="el" href="group__flac__seekable__stream__decoder.html#a14">FLAC__seekable_stream_decoder_delete</a>().</ul>

105

The seekable stream decoder is a wrapper around the <a class="el" href="group__flac__stream__decoder.html">stream decoder</a> which also provides seeking capability. In addition to the Read/Write/Metadata/Error callbacks of the stream decoder, the user must also provide the following:

106

<p>

107

<ul>

108

<li>Seek callback - This function will be called when the decoder wants to seek to an absolute position in the stream.<li>Tell callback - This function will be called when the decoder wants to know the current absolute position of the stream.<li>Length callback - This function will be called when the decoder wants to know length of the stream. The seeking algorithm currently requires that the overall stream length be known.<li>EOF callback - This function will be called when the decoder wants to know if it is at the end of the stream. This could be synthesized from the tell and length callbacks but it may be more expensive that way, so there is a separate callback for it.</ul>

109

Seeking is exposed through the <a class="el" href="group__flac__seekable__stream__decoder.html#a49">FLAC__seekable_stream_decoder_seek_absolute</a>() method. At any point after the seekable stream decoder has been initialized, the user can call this function to seek to an exact sample within the stream. Subsequently, the first time the write callback is called it will be passed a (possibly partial) block starting at that sample.

110

<p>

111

The seekable stream decoder also provides MD5 signature checking. If this is turned on before initialization, <a class="el" href="group__flac__seekable__stream__decoder.html#a42">FLAC__seekable_stream_decoder_finish</a>() will report when the decoded MD5 signature does not match the one stored in the STREAMINFO block. MD5 checking is automatically turned off (until the next <a class="el" href="group__flac__seekable__stream__decoder.html#a44">FLAC__seekable_stream_decoder_reset</a>()) if there is no signature in the STREAMINFO block or when a seek is attempted.

112

<p>

113

Make sure to read the detailed description of the <a class="el" href="group__flac__stream__decoder.html">stream decoder module</a> since the seekable stream decoder inherits much of its behavior.

114

<p>

115

116

Note: </b><dd>

117

The "set" functions may only be called when the decoder is in the state FLAC__SEEKABLE_STREAM_DECODER_UNINITIALIZED, i.e. after <a class="el" href="group__flac__seekable__stream__decoder.html#a13">FLAC__seekable_stream_decoder_new</a>() or <a class="el" href="group__flac__seekable__stream__decoder.html#a42">FLAC__seekable_stream_decoder_finish</a>(), but before <a class="el" href="group__flac__seekable__stream__decoder.html#a41">FLAC__seekable_stream_decoder_init</a>(). If this is the case they will return <code>true</code>, otherwise <code>false</code>.</dl><dl compact><dt><b>

118

Note: </b><dd>

119

<a class="el" href="group__flac__stream__decoder.html#a29">FLAC__stream_decoder_finish</a>() resets all settings to the constructor defaults, including the callbacks. </dl><hr><h2>Typedef Documentation</h2>

120

121

122

<tr>

123

124

125

<tr>

126

<td class="md" nowrap valign="top"> typedef <a class="el" href="group__flac__seekable__stream__decoder.html#a51">FLAC__SeekableStreamDecoderReadStatus</a>(* FLAC__SeekableStreamDecoderReadCallback)(const <a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> *decoder, FLAC__byte buffer[], unsigned *bytes, void *client_data)

127

</table>

128

</td>

129

</tr>

130

</table>

131

132

<tr>

133

<td>

134

135

</td>

136

<td>

137

138

<p>

139

Signature for the read callback. See <a class="el" href="group__flac__seekable__stream__decoder.html#a16">FLAC__seekable_stream_decoder_set_read_callback</a>() and FLAC__StreamDecoderReadCallback for more info.<dl compact><dt><b>

140

Parameters: </b><dd>

141

142

<tr><td valign=top><em>decoder</em> </td><td>

143

The decoder instance calling the callback. </td></tr>

144

<tr><td valign=top><em>buffer</em> </td><td>

145

A pointer to a location for the callee to store data to be decoded. </td></tr>

146

<tr><td valign=top><em>bytes</em> </td><td>

147

A pointer to the size of the buffer. </td></tr>

148

<tr><td valign=top><em>client_data</em> </td><td>

149

The callee's client data set through <a class="el" href="group__flac__seekable__stream__decoder.html#a24">FLAC__seekable_stream_decoder_set_client_data</a>(). </td></tr>

150

</table>

151

</dl><dl compact><dt><b>

152

Return values: </b><dd>

153

154

<tr><td valign=top><em>FLAC__SeekableStreamDecoderReadStatus</em> </td><td>

155

The callee's return status. </td></tr>

156

</table>

157

</dl> </td>

158

</tr>

159

</table>

160

161

162

<tr>

163

164

165

<tr>

166

<td class="md" nowrap valign="top"> typedef <a class="el" href="group__flac__seekable__stream__decoder.html#a52">FLAC__SeekableStreamDecoderSeekStatus</a>(* FLAC__SeekableStreamDecoderSeekCallback)(const <a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> *decoder, FLAC__uint64 absolute_byte_offset, void *client_data)

167

</table>

168

</td>

169

</tr>

170

</table>

171

172

<tr>

173

<td>

174

175

</td>

176

<td>

177

178

<p>

179

Signature for the seek callback. See <a class="el" href="group__flac__seekable__stream__decoder.html#a17">FLAC__seekable_stream_decoder_set_seek_callback</a>() for more info.<dl compact><dt><b>

180

Parameters: </b><dd>

181

182

<tr><td valign=top><em>decoder</em> </td><td>

183

The decoder instance calling the callback. </td></tr>

184

<tr><td valign=top><em>absolute_byte_offset</em> </td><td>

185

The offset from the beginning of the stream to seek to. </td></tr>

186

<tr><td valign=top><em>client_data</em> </td><td>

187

The callee's client data set through <a class="el" href="group__flac__seekable__stream__decoder.html#a24">FLAC__seekable_stream_decoder_set_client_data</a>(). </td></tr>

188

</table>

189

</dl><dl compact><dt><b>

190

Return values: </b><dd>

191

192

<tr><td valign=top><em>FLAC__SeekableStreamDecoderSeekStatus</em> </td><td>

193

The callee's return status. </td></tr>

194

</table>

195

</dl> </td>

196

</tr>

197

</table>

198

199

200

<tr>

201

202

203

<tr>

204

<td class="md" nowrap valign="top"> typedef <a class="el" href="group__flac__seekable__stream__decoder.html#a53">FLAC__SeekableStreamDecoderTellStatus</a>(* FLAC__SeekableStreamDecoderTellCallback)(const <a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> *decoder, FLAC__uint64 *absolute_byte_offset, void *client_data)

205

</table>

206

</td>

207

</tr>

208

</table>

209

210

<tr>

211

<td>

212

213

</td>

214

<td>

215

216

<p>

217

Signature for the tell callback. See <a class="el" href="group__flac__seekable__stream__decoder.html#a18">FLAC__seekable_stream_decoder_set_tell_callback</a>() for more info.<dl compact><dt><b>

218

Parameters: </b><dd>

219

220

<tr><td valign=top><em>decoder</em> </td><td>

221

The decoder instance calling the callback. </td></tr>

222

<tr><td valign=top><em>absolute_byte_offset</em> </td><td>

223

A pointer to storage for the current offset from the beginning of the stream. </td></tr>

224

<tr><td valign=top><em>client_data</em> </td><td>

225

The callee's client data set through <a class="el" href="group__flac__seekable__stream__decoder.html#a24">FLAC__seekable_stream_decoder_set_client_data</a>(). </td></tr>

226

</table>

227

</dl><dl compact><dt><b>

228

Return values: </b><dd>

229

230

<tr><td valign=top><em>FLAC__SeekableStreamDecoderTellStatus</em> </td><td>

231

The callee's return status. </td></tr>

232

</table>

233

</dl> </td>

234

</tr>

235

</table>

236

237

238

<tr>

239

240

241

<tr>

242

<td class="md" nowrap valign="top"> typedef <a class="el" href="group__flac__seekable__stream__decoder.html#a54">FLAC__SeekableStreamDecoderLengthStatus</a>(* FLAC__SeekableStreamDecoderLengthCallback)(const <a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> *decoder, FLAC__uint64 *stream_length, void *client_data)

243

</table>

244

</td>

245

</tr>

246

</table>

247

248

<tr>

249

<td>

250

251

</td>

252

<td>

253

254

<p>

255

Signature for the length callback. See <a class="el" href="group__flac__seekable__stream__decoder.html#a19">FLAC__seekable_stream_decoder_set_length_callback</a>() for more info.<dl compact><dt><b>

256

Parameters: </b><dd>

257

258

<tr><td valign=top><em>decoder</em> </td><td>

259

The decoder instance calling the callback. </td></tr>

260

<tr><td valign=top><em>stream_length</em> </td><td>

261

A pointer to storage for the length of the stream in bytes. </td></tr>

262

<tr><td valign=top><em>client_data</em> </td><td>

263

The callee's client data set through <a class="el" href="group__flac__seekable__stream__decoder.html#a24">FLAC__seekable_stream_decoder_set_client_data</a>(). </td></tr>

264

</table>

265

</dl><dl compact><dt><b>

266

Return values: </b><dd>

267

268

<tr><td valign=top><em>FLAC__SeekableStreamDecoderLengthStatus</em> </td><td>

269

The callee's return status. </td></tr>

270

</table>

271

</dl> </td>

272

</tr>

273

</table>

274

275

276

<tr>

277

278

279

<tr>

280

<td class="md" nowrap valign="top"> typedef FLAC__bool(* FLAC__SeekableStreamDecoderEofCallback)(const <a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> *decoder, void *client_data)

281

</table>

282

</td>

283

</tr>

284

</table>

285

286

<tr>

287

<td>

288

289

</td>

290

<td>

291

292

<p>

293

Signature for the EOF callback. See <a class="el" href="group__flac__seekable__stream__decoder.html#a20">FLAC__seekable_stream_decoder_set_eof_callback</a>() for more info.<dl compact><dt><b>

294

Parameters: </b><dd>

295

296

<tr><td valign=top><em>decoder</em> </td><td>

297

The decoder instance calling the callback. </td></tr>

298

<tr><td valign=top><em>client_data</em> </td><td>

299

The callee's client data set through <a class="el" href="group__flac__seekable__stream__decoder.html#a24">FLAC__seekable_stream_decoder_set_client_data</a>(). </td></tr>

300

</table>

301

</dl><dl compact><dt><b>

302

Return values: </b><dd>

303

304

305

<code>true</code> if the currently at the end of the stream, else <code>false</code>. </td></tr>

306

</table>

307

</dl> </td>

308

</tr>

309

</table>

310

311

312

<tr>

313

314

315

<tr>

316

<td class="md" nowrap valign="top"> typedef <a class="el" href="group__flac__stream__decoder.html#a38">FLAC__StreamDecoderWriteStatus</a>(* FLAC__SeekableStreamDecoderWriteCallback)(const <a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> *decoder, const <a class="el" href="structFLAC____Frame.html">FLAC__Frame</a> *frame, const FLAC__int32 * const buffer[], void *client_data)

317

</table>

318

</td>

319

</tr>

320

</table>

321

322

<tr>

323

<td>

324

325

</td>

326

<td>

327

328

<p>

329

Signature for the write callback. See <a class="el" href="group__flac__seekable__stream__decoder.html#a21">FLAC__seekable_stream_decoder_set_write_callback</a>() and FLAC__StreamDecoderWriteCallback for more info.<dl compact><dt><b>

330

Parameters: </b><dd>

331

332

<tr><td valign=top><em>decoder</em> </td><td>

333

The decoder instance calling the callback. </td></tr>

334

<tr><td valign=top><em>frame</em> </td><td>

335

The description of the decoded frame. </td></tr>

336

<tr><td valign=top><em>buffer</em> </td><td>

337

An array of pointers to decoded channels of data. </td></tr>

338

<tr><td valign=top><em>client_data</em> </td><td>

339

The callee's client data set through <a class="el" href="group__flac__seekable__stream__decoder.html#a24">FLAC__seekable_stream_decoder_set_client_data</a>(). </td></tr>

340

</table>

341

</dl><dl compact><dt><b>

342

Return values: </b><dd>

343

344

<tr><td valign=top><em>FLAC__StreamDecoderWriteStatus</em> </td><td>

345

The callee's return status. </td></tr>

346

</table>

347

</dl> </td>

348

</tr>

349

</table>

350

351

352

<tr>

353

354

355

<tr>

356

<td class="md" nowrap valign="top"> typedef void(* FLAC__SeekableStreamDecoderMetadataCallback)(const <a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> *decoder, const <a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> *metadata, void *client_data)

357

</table>

358

</td>

359

</tr>

360

</table>

361

362

<tr>

363

<td>

364

365

</td>

366

<td>

367

368

<p>

369

Signature for the metadata callback. See <a class="el" href="group__flac__seekable__stream__decoder.html#a22">FLAC__seekable_stream_decoder_set_metadata_callback</a>() and FLAC__StreamDecoderMetadataCallback for more info.<dl compact><dt><b>

370

Parameters: </b><dd>

371

372

<tr><td valign=top><em>decoder</em> </td><td>

373

The decoder instance calling the callback. </td></tr>

374

<tr><td valign=top><em>metadata</em> </td><td>

375

The decoded metadata block. </td></tr>

376

<tr><td valign=top><em>client_data</em> </td><td>

377

The callee's client data set through <a class="el" href="group__flac__seekable__stream__decoder.html#a24">FLAC__seekable_stream_decoder_set_client_data</a>(). </td></tr>

378

</table>

379

</dl> </td>

380

</tr>

381

</table>

382

383

384

<tr>

385

386

387

<tr>

388

<td class="md" nowrap valign="top"> typedef void(* FLAC__SeekableStreamDecoderErrorCallback)(const <a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> *decoder, <a class="el" href="group__flac__stream__decoder.html#a39">FLAC__StreamDecoderErrorStatus</a> status, void *client_data)

389

</table>

390

</td>

391

</tr>

392

</table>

393

394

<tr>

395

<td>

396

397

</td>

398

<td>

399

400

<p>

401

Signature for the error callback. See <a class="el" href="group__flac__seekable__stream__decoder.html#a23">FLAC__seekable_stream_decoder_set_error_callback</a>() and FLAC__StreamDecoderErrorCallback for more info.<dl compact><dt><b>

402

Parameters: </b><dd>

403

404

<tr><td valign=top><em>decoder</em> </td><td>

405

The decoder instance calling the callback. </td></tr>

406

<tr><td valign=top><em>status</em> </td><td>

407

The error encountered by the decoder. </td></tr>

408

<tr><td valign=top><em>client_data</em> </td><td>

409

The callee's client data set through <a class="el" href="group__flac__seekable__stream__decoder.html#a24">FLAC__seekable_stream_decoder_set_client_data</a>(). </td></tr>

410

</table>

411

</dl> </td>

412

</tr>

413

</table>

414

<hr><h2>Enumeration Type Documentation</h2>

415

416

417

<tr>

418

419

420

<tr>

421

<td class="md" nowrap valign="top"> enum FLAC__SeekableStreamDecoderState

422

</table>

423

</td>

424

</tr>

425

</table>

426

427

<tr>

428

<td>

429

430

</td>

431

<td>

432

433

<p>

434

State values for a <a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a>

435

<p>

436

The decoder's state can be obtained by calling <a class="el" href="group__flac__seekable__stream__decoder.html#a31">FLAC__seekable_stream_decoder_get_state</a>(). <dl compact><dt><b>

437

Enumeration values:</b><dd>

438

439

<tr><td valign=top><em><a name="a50a13" doxytag="FLAC__SEEKABLE_STREAM_DECODER_OK"></a><em>FLAC__SEEKABLE_STREAM_DECODER_OK</em></em> </td><td>

440

The decoder is in the normal OK state. </td></tr>

441

<tr><td valign=top><em><a name="a50a14" doxytag="FLAC__SEEKABLE_STREAM_DECODER_SEEKING"></a><em>FLAC__SEEKABLE_STREAM_DECODER_SEEKING</em></em> </td><td>

442

The decoder is in the process of seeking. </td></tr>

443

<tr><td valign=top><em><a name="a50a15" doxytag="FLAC__SEEKABLE_STREAM_DECODER_END_OF_STREAM"></a><em>FLAC__SEEKABLE_STREAM_DECODER_END_OF_STREAM</em></em> </td><td>

444

The decoder has reached the end of the stream. </td></tr>

445

<tr><td valign=top><em><a name="a50a16" doxytag="FLAC__SEEKABLE_STREAM_DECODER_MEMORY_ALLOCATION_ERROR"></a><em>FLAC__SEEKABLE_STREAM_DECODER_MEMORY_ALLOCATION_ERROR</em></em> </td><td>

446

An error occurred allocating memory. </td></tr>

447

<tr><td valign=top><em><a name="a50a17" doxytag="FLAC__SEEKABLE_STREAM_DECODER_STREAM_DECODER_ERROR"></a><em>FLAC__SEEKABLE_STREAM_DECODER_STREAM_DECODER_ERROR</em></em> </td><td>

448

An error occurred in the underlying stream decoder. </td></tr>

449

<tr><td valign=top><em><a name="a50a18" doxytag="FLAC__SEEKABLE_STREAM_DECODER_READ_ERROR"></a><em>FLAC__SEEKABLE_STREAM_DECODER_READ_ERROR</em></em> </td><td>

450

The read callback returned an error. </td></tr>

451

<tr><td valign=top><em><a name="a50a19" doxytag="FLAC__SEEKABLE_STREAM_DECODER_SEEK_ERROR"></a><em>FLAC__SEEKABLE_STREAM_DECODER_SEEK_ERROR</em></em> </td><td>

452

An error occurred while seeking or the seek or tell callback returned an error. </td></tr>

453

<tr><td valign=top><em><a name="a50a20" doxytag="FLAC__SEEKABLE_STREAM_DECODER_ALREADY_INITIALIZED"></a><em>FLAC__SEEKABLE_STREAM_DECODER_ALREADY_INITIALIZED</em></em> </td><td>

454

<a class="el" href="group__flac__seekable__stream__decoder.html#a41">FLAC__seekable_stream_decoder_init</a>() was called when the decoder was already initialized, usually because <a class="el" href="group__flac__seekable__stream__decoder.html#a42">FLAC__seekable_stream_decoder_finish</a>() was not called. </td></tr>

455

<tr><td valign=top><em><a name="a50a21" doxytag="FLAC__SEEKABLE_STREAM_DECODER_INVALID_CALLBACK"></a><em>FLAC__SEEKABLE_STREAM_DECODER_INVALID_CALLBACK</em></em> </td><td>

456

<a class="el" href="group__flac__seekable__stream__decoder.html#a41">FLAC__seekable_stream_decoder_init</a>() was called without all callbacks being set. </td></tr>

457

<tr><td valign=top><em><a name="a50a22" doxytag="FLAC__SEEKABLE_STREAM_DECODER_UNINITIALIZED"></a><em>FLAC__SEEKABLE_STREAM_DECODER_UNINITIALIZED</em></em> </td><td>

458

The decoder is in the uninitialized state. </td></tr>

459

</table>

460

</dl>

461

</td>

462

</tr>

463

</table>

464

465

466

<tr>

467

468

469

<tr>

470

<td class="md" nowrap valign="top"> enum FLAC__SeekableStreamDecoderReadStatus

471

</table>

472

</td>

473

</tr>

474

</table>

475

476

<tr>

477

<td>

478

479

</td>

480

<td>

481

482

<p>

483

Return values for the <a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> read callback. <dl compact><dt><b>

484

Enumeration values:</b><dd>

485

486

<tr><td valign=top><em><a name="a51a23" doxytag="FLAC__SEEKABLE_STREAM_DECODER_READ_STATUS_OK"></a><em>FLAC__SEEKABLE_STREAM_DECODER_READ_STATUS_OK</em></em> </td><td>

487

The read was OK and decoding can continue. </td></tr>

488

<tr><td valign=top><em><a name="a51a24" doxytag="FLAC__SEEKABLE_STREAM_DECODER_READ_STATUS_ERROR"></a><em>FLAC__SEEKABLE_STREAM_DECODER_READ_STATUS_ERROR</em></em> </td><td>

489

An unrecoverable error occurred. The decoder will return from the process call. </td></tr>

490

</table>

491

</dl>

492

</td>

493

</tr>

494

</table>

495

496

497

<tr>

498

499

500

<tr>

501

<td class="md" nowrap valign="top"> enum FLAC__SeekableStreamDecoderSeekStatus

502

</table>

503

</td>

504

</tr>

505

</table>

506

507

<tr>

508

<td>

509

510

</td>

511

<td>

512

513

<p>

514

Return values for the <a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> seek callback. <dl compact><dt><b>

515

Enumeration values:</b><dd>

516

517

<tr><td valign=top><em><a name="a52a25" doxytag="FLAC__SEEKABLE_STREAM_DECODER_SEEK_STATUS_OK"></a><em>FLAC__SEEKABLE_STREAM_DECODER_SEEK_STATUS_OK</em></em> </td><td>

518

The seek was OK and decoding can continue. </td></tr>

519

<tr><td valign=top><em><a name="a52a26" doxytag="FLAC__SEEKABLE_STREAM_DECODER_SEEK_STATUS_ERROR"></a><em>FLAC__SEEKABLE_STREAM_DECODER_SEEK_STATUS_ERROR</em></em> </td><td>

520

An unrecoverable error occurred. The decoder will return from the process call. </td></tr>

521

</table>

522

</dl>

523

</td>

524

</tr>

525

</table>

526

527

528

<tr>

529

530

531

<tr>

532

<td class="md" nowrap valign="top"> enum FLAC__SeekableStreamDecoderTellStatus

533

</table>

534

</td>

535

</tr>

536

</table>

537

538

<tr>

539

<td>

540

541

</td>

542

<td>

543

544

<p>

545

Return values for the <a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> tell callback. <dl compact><dt><b>

546

Enumeration values:</b><dd>

547

548

<tr><td valign=top><em><a name="a53a27" doxytag="FLAC__SEEKABLE_STREAM_DECODER_TELL_STATUS_OK"></a><em>FLAC__SEEKABLE_STREAM_DECODER_TELL_STATUS_OK</em></em> </td><td>

549

The tell was OK and decoding can continue. </td></tr>

550

<tr><td valign=top><em><a name="a53a28" doxytag="FLAC__SEEKABLE_STREAM_DECODER_TELL_STATUS_ERROR"></a><em>FLAC__SEEKABLE_STREAM_DECODER_TELL_STATUS_ERROR</em></em> </td><td>

551

An unrecoverable error occurred. The decoder will return from the process call. </td></tr>

552

</table>

553

</dl>

554

</td>

555

</tr>

556

</table>

557

558

559

<tr>

560

561

562

<tr>

563

<td class="md" nowrap valign="top"> enum FLAC__SeekableStreamDecoderLengthStatus

564

</table>

565

</td>

566

</tr>

567

</table>

568

569

<tr>

570

<td>

571

572

</td>

573

<td>

574

575

<p>

576

Return values for the <a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> length callback. <dl compact><dt><b>

577

Enumeration values:</b><dd>

578

579

<tr><td valign=top><em><a name="a54a29" doxytag="FLAC__SEEKABLE_STREAM_DECODER_LENGTH_STATUS_OK"></a><em>FLAC__SEEKABLE_STREAM_DECODER_LENGTH_STATUS_OK</em></em> </td><td>

580

The length call was OK and decoding can continue. </td></tr>

581

<tr><td valign=top><em><a name="a54a30" doxytag="FLAC__SEEKABLE_STREAM_DECODER_LENGTH_STATUS_ERROR"></a><em>FLAC__SEEKABLE_STREAM_DECODER_LENGTH_STATUS_ERROR</em></em> </td><td>

582

An unrecoverable error occurred. The decoder will return from the process call. </td></tr>

583

</table>

584

</dl>

585

</td>

586

</tr>

587

</table>

588

<hr><h2>Function Documentation</h2>

589

590

591

<tr>

592

593

594

<tr>

595

<td class="md" nowrap valign="top"> <a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a>* FLAC__seekable_stream_decoder_new </td>

596

597

598

599

600

</tr>

601

602

</table>

603

</td>

604

</tr>

605

</table>

606

607

<tr>

608

<td>

609

610

</td>

611

<td>

612

613

<p>

614

Create a new seekable stream decoder instance. The instance is created with default settings; see the individual FLAC__seekable_stream_decoder_set_*() functions for each setting's default.<dl compact><dt><b>

615

Return values: </b><dd>

616

617

<tr><td valign=top><em><a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a></em> </td><td>

618

* <code>NULL</code> if there was an error allocating memory, else the new instance. </td></tr>

619

</table>

620

</dl> </td>

621

</tr>

622

</table>

623

624

625

<tr>

626

627

628

<tr>

629

<td class="md" nowrap valign="top"> void FLAC__seekable_stream_decoder_delete </td>

630

631

<td class="md" nowrap valign="top"><a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> * </td>

632

<td class="mdname1" valign="top" nowrap>  <em>decoder</em> </td>

633

634

635

</tr>

636

637

</table>

638

</td>

639

</tr>

640

</table>

641

642

<tr>

643

<td>

644

645

</td>

646

<td>

647

648

<p>

649

Free a decoder instance. Deletes the object pointed to by <em>decoder</em>.<dl compact><dt><b>

650

Parameters: </b><dd>

651

652

<tr><td valign=top><em>decoder</em> </td><td>

653

A pointer to an existing decoder. </td></tr>

654

</table>

655

</dl><dl compact><dt><b>

656

Assertions:</b><dd>

657

<div class="fragment"><pre>decoder != NULL

658

</pre></div> </dl> </td>

659

</tr>

660

</table>

661

662

663

<tr>

664

665

666

<tr>

667

<td class="md" nowrap valign="top"> FLAC__bool FLAC__seekable_stream_decoder_set_md5_checking </td>

668

669

<td class="md" nowrap valign="top"><a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> * </td>

670

<td class="mdname" nowrap>  <em>decoder</em>, </td>

671

</tr>

672

<tr>

673

674

675

676

<td class="mdname" nowrap>  <em>value</em></td>

677

</tr>

678

<tr>

679

680

681

682

</tr>

683

684

</table>

685

</td>

686

</tr>

687

</table>

688

689

<tr>

690

<td>

691

692

</td>

693

<td>

694

695

<p>

696

Set the "MD5 signature checking" flag. If <code>true</code>, the decoder will compute the MD5 signature of the unencoded audio data while decoding and compare it to the signature from the STREAMINFO block, if it exists, during <a class="el" href="group__flac__seekable__stream__decoder.html#a42">FLAC__seekable_stream_decoder_finish</a>().

697

<p>

698

MD5 signature checking will be turned off (until the next <a class="el" href="group__flac__seekable__stream__decoder.html#a44">FLAC__seekable_stream_decoder_reset</a>()) if there is no signature in the STREAMINFO block or when a seek is attempted.<dl compact><dt><b>

699

Default Value:</b><dd>

700

<code>false</code> </dl><dl compact><dt><b>

701

Parameters: </b><dd>

702

703

<tr><td valign=top><em>decoder</em> </td><td>

704

A decoder instance to set. </td></tr>

705

<tr><td valign=top><em>value</em> </td><td>

706

Flag value (see above). </td></tr>

707

</table>

708

</dl><dl compact><dt><b>

709

Assertions:</b><dd>

710

<div class="fragment"><pre>decoder != NULL

711

</pre></div> </dl><dl compact><dt><b>

712

Return values: </b><dd>

713

714

715

<code>false</code> if the decoder is already initialized, else <code>true</code>. </td></tr>

716

</table>

717

</dl> </td>

718

</tr>

719

</table>

720

721

722

<tr>

723

724

725

<tr>

726

<td class="md" nowrap valign="top"> FLAC__bool FLAC__seekable_stream_decoder_set_read_callback </td>

727

728

<td class="md" nowrap valign="top"><a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> * </td>

729

<td class="mdname" nowrap>  <em>decoder</em>, </td>

730

</tr>

731

<tr>

732

733

734

<td class="md" nowrap><a class="el" href="group__flac__seekable__stream__decoder.html#a5">FLAC__SeekableStreamDecoderReadCallback</a> </td>

735

<td class="mdname" nowrap>  <em>value</em></td>

736

</tr>

737

<tr>

738

739

740

741

</tr>

742

743

</table>

744

</td>

745

</tr>

746

</table>

747

748

<tr>

749

<td>

750

751

</td>

752

<td>

753

754

<p>

755

Set the read callback. This is inherited from <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a>; see <a class="el" href="group__flac__stream__decoder.html#a10">FLAC__stream_decoder_set_read_callback</a>().

756

<p>

757

758

Note: </b><dd>

759

The callback is mandatory and must be set before initialization.</dl><dl compact><dt><b>

760

Default Value:</b><dd>

761

762

Parameters: </b><dd>

763

764

<tr><td valign=top><em>decoder</em> </td><td>

765

A decoder instance to set. </td></tr>

766

<tr><td valign=top><em>value</em> </td><td>

767

See above. </td></tr>

768

</table>

769

</dl><dl compact><dt><b>

770

Assertions:</b><dd>

771

<div class="fragment"><pre>decoder != NULL

772

</pre></div> <div class="fragment"><pre>value != NULL

773

</pre></div> </dl><dl compact><dt><b>

774

Return values: </b><dd>

775

776

777

<code>false</code> if the decoder is already initialized, else <code>true</code>. </td></tr>

778

</table>

779

</dl> </td>

780

</tr>

781

</table>

782

783

784

<tr>

785

786

787

<tr>

788

<td class="md" nowrap valign="top"> FLAC__bool FLAC__seekable_stream_decoder_set_seek_callback </td>

789

790

<td class="md" nowrap valign="top"><a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> * </td>

791

<td class="mdname" nowrap>  <em>decoder</em>, </td>

792

</tr>

793

<tr>

794

795

796

<td class="md" nowrap><a class="el" href="group__flac__seekable__stream__decoder.html#a6">FLAC__SeekableStreamDecoderSeekCallback</a> </td>

797

<td class="mdname" nowrap>  <em>value</em></td>

798

</tr>

799

<tr>

800

801

802

803

</tr>

804

805

</table>

806

</td>

807

</tr>

808

</table>

809

810

<tr>

811

<td>

812

813

</td>

814

<td>

815

816

<p>

817

Set the seek callback. The supplied function will be called when the decoder needs to seek the input stream. The decoder will pass the absolute byte offset to seek to, 0 meaning the beginning of the stream.

818

<p>

819

820

Note: </b><dd>

821

The callback is mandatory and must be set before initialization.</dl><dl compact><dt><b>

822

Default Value:</b><dd>

823

824

Parameters: </b><dd>

825

826

<tr><td valign=top><em>decoder</em> </td><td>

827

A decoder instance to set. </td></tr>

828

<tr><td valign=top><em>value</em> </td><td>

829

See above. </td></tr>

830

</table>

831

</dl><dl compact><dt><b>

832

Assertions:</b><dd>

833

<div class="fragment"><pre>decoder != NULL

834

</pre></div> <div class="fragment"><pre>value != NULL

835

</pre></div> </dl><dl compact><dt><b>

836

Return values: </b><dd>

837

838

839

<code>false</code> if the decoder is already initialized, else <code>true</code>. </td></tr>

840

</table>

841

</dl> </td>

842

</tr>

843

</table>

844

845

846

<tr>

847

848

849

<tr>

850

<td class="md" nowrap valign="top"> FLAC__bool FLAC__seekable_stream_decoder_set_tell_callback </td>

851

852

<td class="md" nowrap valign="top"><a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> * </td>

853

<td class="mdname" nowrap>  <em>decoder</em>, </td>

854

</tr>

855

<tr>

856

857

858

<td class="md" nowrap><a class="el" href="group__flac__seekable__stream__decoder.html#a7">FLAC__SeekableStreamDecoderTellCallback</a> </td>

859

<td class="mdname" nowrap>  <em>value</em></td>

860

</tr>

861

<tr>

862

863

864

865

</tr>

866

867

</table>

868

</td>

869

</tr>

870

</table>

871

872

<tr>

873

<td>

874

875

</td>

876

<td>

877

878

<p>

879

Set the tell callback. The supplied function will be called when the decoder wants to know the current position of the stream. The callback should return the byte offset from the beginning of the stream.

880

<p>

881

882

Note: </b><dd>

883

The callback is mandatory and must be set before initialization.</dl><dl compact><dt><b>

884

Default Value:</b><dd>

885

886

Parameters: </b><dd>

887

888

<tr><td valign=top><em>decoder</em> </td><td>

889

A decoder instance to set. </td></tr>

890

<tr><td valign=top><em>value</em> </td><td>

891

See above. </td></tr>

892

</table>

893

</dl><dl compact><dt><b>

894

Assertions:</b><dd>

895

<div class="fragment"><pre>decoder != NULL

896

</pre></div> <div class="fragment"><pre>value != NULL

897

</pre></div> </dl><dl compact><dt><b>

898

Return values: </b><dd>

899

900

901

<code>false</code> if the decoder is already initialized, else <code>true</code>. </td></tr>

902

</table>

903

</dl> </td>

904

</tr>

905

</table>

906

907

908

<tr>

909

910

911

<tr>

912

<td class="md" nowrap valign="top"> FLAC__bool FLAC__seekable_stream_decoder_set_length_callback </td>

913

914

<td class="md" nowrap valign="top"><a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> * </td>

915

<td class="mdname" nowrap>  <em>decoder</em>, </td>

916

</tr>

917

<tr>

918

919

920

<td class="md" nowrap><a class="el" href="group__flac__seekable__stream__decoder.html#a8">FLAC__SeekableStreamDecoderLengthCallback</a> </td>

921

<td class="mdname" nowrap>  <em>value</em></td>

922

</tr>

923

<tr>

924

925

926

927

</tr>

928

929

</table>

930

</td>

931

</tr>

932

</table>

933

934

<tr>

935

<td>

936

937

</td>

938

<td>

939

940

<p>

941

Set the length callback. The supplied function will be called when the decoder wants to know the total length of the stream in bytes.

942

<p>

943

944

Note: </b><dd>

945

The callback is mandatory and must be set before initialization.</dl><dl compact><dt><b>

946

Default Value:</b><dd>

947

948

Parameters: </b><dd>

949

950

<tr><td valign=top><em>decoder</em> </td><td>

951

A decoder instance to set. </td></tr>

952

<tr><td valign=top><em>value</em> </td><td>

953

See above. </td></tr>

954

</table>

955

</dl><dl compact><dt><b>

956

Assertions:</b><dd>

957

<div class="fragment"><pre>decoder != NULL

958

</pre></div> <div class="fragment"><pre>value != NULL

959

</pre></div> </dl><dl compact><dt><b>

960

Return values: </b><dd>

961

962

963

<code>false</code> if the decoder is already initialized, else <code>true</code>. </td></tr>

964

</table>

965

</dl> </td>

966

</tr>

967

</table>

968

969

970

<tr>

971

972

973

<tr>

974

<td class="md" nowrap valign="top"> FLAC__bool FLAC__seekable_stream_decoder_set_eof_callback </td>

975

976

<td class="md" nowrap valign="top"><a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> * </td>

977

<td class="mdname" nowrap>  <em>decoder</em>, </td>

978

</tr>

979

<tr>

980

981

982

<td class="md" nowrap><a class="el" href="group__flac__seekable__stream__decoder.html#a9">FLAC__SeekableStreamDecoderEofCallback</a> </td>

983

<td class="mdname" nowrap>  <em>value</em></td>

984

</tr>

985

<tr>

986

987

988

989

</tr>

990

991

</table>

992

</td>

993

</tr>

994

</table>

995

996

<tr>

997

<td>

998

999

</td>

1000

<td>

1001

1002

<p>

1003

Set the eof callback. The supplied function will be called when the decoder needs to know if the end of the stream has been reached.

1004

<p>

1005

1006

Note: </b><dd>

1007

The callback is mandatory and must be set before initialization.</dl><dl compact><dt><b>

1008

Default Value:</b><dd>

1009

1010

Parameters: </b><dd>

1011

1012

<tr><td valign=top><em>decoder</em> </td><td>

1013

A decoder instance to set. </td></tr>

1014

<tr><td valign=top><em>value</em> </td><td>

1015

See above. </td></tr>

1016

</table>

1017

</dl><dl compact><dt><b>

1018

Assertions:</b><dd>

1019

<div class="fragment"><pre>decoder != NULL

1020

</pre></div> <div class="fragment"><pre>value != NULL

1021

</pre></div> </dl><dl compact><dt><b>

1022

Return values: </b><dd>

1023

1024

1025

<code>false</code> if the decoder is already initialized, else <code>true</code>. </td></tr>

1026

</table>

1027

</dl> </td>

1028

</tr>

1029

</table>

1030

1031

1032

<tr>

1033

1034

1035

<tr>

1036

<td class="md" nowrap valign="top"> FLAC__bool FLAC__seekable_stream_decoder_set_write_callback </td>

1037

1038

<td class="md" nowrap valign="top"><a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> * </td>

1039

<td class="mdname" nowrap>  <em>decoder</em>, </td>

1040

</tr>

1041

<tr>

1042

1043

1044

<td class="md" nowrap><a class="el" href="group__flac__seekable__stream__decoder.html#a10">FLAC__SeekableStreamDecoderWriteCallback</a> </td>

1045

<td class="mdname" nowrap>  <em>value</em></td>

1046

</tr>

1047

<tr>

1048

1049

1050

1051

</tr>

1052

1053

</table>

1054

</td>

1055

</tr>

1056

</table>

1057

1058

<tr>

1059

<td>

1060

1061

</td>

1062

<td>

1063

1064

<p>

1065

Set the write callback. This is inherited from <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a>; see <a class="el" href="group__flac__stream__decoder.html#a11">FLAC__stream_decoder_set_write_callback</a>().

1066

<p>

1067

1068

Note: </b><dd>

1069

The callback is mandatory and must be set before initialization.</dl><dl compact><dt><b>

1070

Default Value:</b><dd>

1071

1072

Parameters: </b><dd>

1073

1074

<tr><td valign=top><em>decoder</em> </td><td>

1075

A decoder instance to set. </td></tr>

1076

<tr><td valign=top><em>value</em> </td><td>

1077

See above. </td></tr>

1078

</table>

1079

</dl><dl compact><dt><b>

1080

Assertions:</b><dd>

1081

<div class="fragment"><pre>decoder != NULL

1082

</pre></div> <div class="fragment"><pre>value != NULL

1083

</pre></div> </dl><dl compact><dt><b>

1084

Return values: </b><dd>

1085

1086

1087

<code>false</code> if the decoder is already initialized, else <code>true</code>. </td></tr>

1088

</table>

1089

</dl> </td>

1090

</tr>

1091

</table>

1092

1093

1094

<tr>

1095

1096

1097

<tr>

1098

<td class="md" nowrap valign="top"> FLAC__bool FLAC__seekable_stream_decoder_set_metadata_callback </td>

1099

1100

<td class="md" nowrap valign="top"><a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> * </td>

1101

<td class="mdname" nowrap>  <em>decoder</em>, </td>

1102

</tr>

1103

<tr>

1104

1105

1106

<td class="md" nowrap><a class="el" href="group__flac__seekable__stream__decoder.html#a11">FLAC__SeekableStreamDecoderMetadataCallback</a> </td>

1107

<td class="mdname" nowrap>  <em>value</em></td>

1108

</tr>

1109

<tr>

1110

1111

1112

1113

</tr>

1114

1115

</table>

1116

</td>

1117

</tr>

1118

</table>

1119

1120

<tr>

1121

<td>

1122

1123

</td>

1124

<td>

1125

1126

<p>

1127

Set the metadata callback. This is inherited from <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a>; see <a class="el" href="group__flac__stream__decoder.html#a12">FLAC__stream_decoder_set_metadata_callback</a>().

1128

<p>

1129

1130

Note: </b><dd>

1131

The callback is mandatory and must be set before initialization.</dl><dl compact><dt><b>

1132

Default Value:</b><dd>

1133

1134

Parameters: </b><dd>

1135

1136

<tr><td valign=top><em>decoder</em> </td><td>

1137

A decoder instance to set. </td></tr>

1138

<tr><td valign=top><em>value</em> </td><td>

1139

See above. </td></tr>

1140

</table>

1141

</dl><dl compact><dt><b>

1142

Assertions:</b><dd>

1143

<div class="fragment"><pre>decoder != NULL

1144

</pre></div> <div class="fragment"><pre>value != NULL

1145

</pre></div> </dl><dl compact><dt><b>

1146

Return values: </b><dd>

1147

1148

1149

<code>false</code> if the decoder is already initialized, else <code>true</code>. </td></tr>

1150

</table>

1151

</dl> </td>

1152

</tr>

1153

</table>

1154

1155

1156

<tr>

1157

1158

1159

<tr>

1160

<td class="md" nowrap valign="top"> FLAC__bool FLAC__seekable_stream_decoder_set_error_callback </td>

1161

1162

<td class="md" nowrap valign="top"><a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> * </td>

1163

<td class="mdname" nowrap>  <em>decoder</em>, </td>

1164

</tr>

1165

<tr>

1166

1167

1168

<td class="md" nowrap><a class="el" href="group__flac__seekable__stream__decoder.html#a12">FLAC__SeekableStreamDecoderErrorCallback</a> </td>

1169

<td class="mdname" nowrap>  <em>value</em></td>

1170

</tr>

1171

<tr>

1172

1173

1174

1175

</tr>

1176

1177

</table>

1178

</td>

1179

</tr>

1180

</table>

1181

1182

<tr>

1183

<td>

1184

1185

</td>

1186

<td>

1187

1188

<p>

1189

Set the error callback. This is inherited from <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a>; see <a class="el" href="group__flac__stream__decoder.html#a13">FLAC__stream_decoder_set_error_callback</a>().

1190

<p>

1191

1192

Note: </b><dd>

1193

The callback is mandatory and must be set before initialization.</dl><dl compact><dt><b>

1194

Default Value:</b><dd>

1195

1196

Parameters: </b><dd>

1197

1198

<tr><td valign=top><em>decoder</em> </td><td>

1199

A decoder instance to set. </td></tr>

1200

<tr><td valign=top><em>value</em> </td><td>

1201

See above. </td></tr>

1202

</table>

1203

</dl><dl compact><dt><b>

1204

Assertions:</b><dd>

1205

<div class="fragment"><pre>decoder != NULL

1206

</pre></div> <div class="fragment"><pre>value != NULL

1207

</pre></div> </dl><dl compact><dt><b>

1208

Return values: </b><dd>

1209

1210

1211

<code>false</code> if the decoder is already initialized, else <code>true</code>. </td></tr>

1212

</table>

1213

</dl> </td>

1214

</tr>

1215

</table>

1216

1217

1218

<tr>

1219

1220

1221

<tr>

1222

<td class="md" nowrap valign="top"> FLAC__bool FLAC__seekable_stream_decoder_set_client_data </td>

1223

1224

<td class="md" nowrap valign="top"><a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> * </td>

1225

<td class="mdname" nowrap>  <em>decoder</em>, </td>

1226

</tr>

1227

<tr>

1228

1229

1230

1231

<td class="mdname" nowrap>  <em>value</em></td>

1232

</tr>

1233

<tr>

1234

1235

1236

1237

</tr>

1238

1239

</table>

1240

</td>

1241

</tr>

1242

</table>

1243

1244

<tr>

1245

<td>

1246

1247

</td>

1248

<td>

1249

1250

<p>

1251

Set the client data to be passed back to callbacks. This value will be supplied to callbacks in their <em>client_data</em> argument.<dl compact><dt><b>

1252

Default Value:</b><dd>

1253

1254

Parameters: </b><dd>

1255

1256

<tr><td valign=top><em>decoder</em> </td><td>

1257

A decoder instance to set. </td></tr>

1258

<tr><td valign=top><em>value</em> </td><td>

1259

See above. </td></tr>

1260

</table>

1261

</dl><dl compact><dt><b>

1262

Assertions:</b><dd>

1263

<div class="fragment"><pre>decoder != NULL

1264

</pre></div> </dl><dl compact><dt><b>

1265

Return values: </b><dd>

1266

1267

1268

<code>false</code> if the decoder is already initialized, else <code>true</code>. </td></tr>

1269

</table>

1270

</dl> </td>

1271

</tr>

1272

</table>

1273

1274

1275

<tr>

1276

1277

1278

<tr>

1279

<td class="md" nowrap valign="top"> FLAC__bool FLAC__seekable_stream_decoder_set_metadata_respond </td>

1280

1281

<td class="md" nowrap valign="top"><a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> * </td>

1282

<td class="mdname" nowrap>  <em>decoder</em>, </td>

1283

</tr>

1284

<tr>

1285

1286

1287

<td class="md" nowrap><a class="el" href="group__flac__format.html#a97">FLAC__MetadataType</a> </td>

1288

1289

</tr>

1290

<tr>

1291

1292

1293

1294

</tr>

1295

1296

</table>

1297

</td>

1298

</tr>

1299

</table>

1300

1301

<tr>

1302

<td>

1303

1304

</td>

1305

<td>

1306

1307

<p>

1308

This is inherited from <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a>; see <a class="el" href="group__flac__stream__decoder.html#a15">FLAC__stream_decoder_set_metadata_respond</a>().<dl compact><dt><b>

1309

Default Value:</b><dd>

1310

By default, only the <code>STREAMINFO</code> block is returned via the metadata callback. </dl><dl compact><dt><b>

1311

Parameters: </b><dd>

1312

1313

<tr><td valign=top><em>decoder</em> </td><td>

1314

A decoder instance to set. </td></tr>

1315

1316

See above. </td></tr>

1317

</table>

1318

</dl><dl compact><dt><b>

1319

Assertions:</b><dd>

1320

<div class="fragment"><pre>decoder != NULL

1321

</pre></div> <em>type</em> is valid </dl><dl compact><dt><b>

1322

Return values: </b><dd>

1323

1324

1325

<code>false</code> if the decoder is already initialized, else <code>true</code>. </td></tr>

1326

</table>

1327

</dl> </td>

1328

</tr>

1329

</table>

1330

1331

1332

<tr>

1333

1334

1335

<tr>

1336

<td class="md" nowrap valign="top"> FLAC__bool FLAC__seekable_stream_decoder_set_metadata_respond_application </td>

1337

1338

<td class="md" nowrap valign="top"><a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> * </td>

1339

<td class="mdname" nowrap>  <em>decoder</em>, </td>

1340

</tr>

1341

<tr>

1342

1343

1344

<td class="md" nowrap>const FLAC__byte </td>

1345

1346

</tr>

1347

<tr>

1348

1349

1350

1351

</tr>

1352

1353

</table>

1354

</td>

1355

</tr>

1356

</table>

1357

1358

<tr>

1359

<td>

1360

1361

</td>

1362

<td>

1363

1364

<p>

1365

This is inherited from <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a>; see <a class="el" href="group__flac__stream__decoder.html#a16">FLAC__stream_decoder_set_metadata_respond_application</a>().<dl compact><dt><b>

1366

Default Value:</b><dd>

1367

By default, only the <code>STREAMINFO</code> block is returned via the metadata callback. </dl><dl compact><dt><b>

1368

Parameters: </b><dd>

1369

1370

<tr><td valign=top><em>decoder</em> </td><td>

1371

A decoder instance to set. </td></tr>

1372

1373

See above. </td></tr>

1374

</table>

1375

</dl><dl compact><dt><b>

1376

Assertions:</b><dd>

1377

<div class="fragment"><pre>decoder != NULL

1378

</pre></div> <div class="fragment"><pre>id != NULL

1379

</pre></div> </dl><dl compact><dt><b>

1380

Return values: </b><dd>

1381

1382

1383

<code>false</code> if the decoder is already initialized, else <code>true</code>. </td></tr>

1384

</table>

1385

</dl> </td>

1386

</tr>

1387

</table>

1388

1389

1390

<tr>

1391

1392

1393

<tr>

1394

<td class="md" nowrap valign="top"> FLAC__bool FLAC__seekable_stream_decoder_set_metadata_respond_all </td>

1395

1396

<td class="md" nowrap valign="top"><a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> * </td>

1397

<td class="mdname1" valign="top" nowrap>  <em>decoder</em> </td>

1398

1399

1400

</tr>

1401

1402

</table>

1403

</td>

1404

</tr>

1405

</table>

1406

1407

<tr>

1408

<td>

1409

1410

</td>

1411

<td>

1412

1413

<p>

1414

This is inherited from <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a>; see <a class="el" href="group__flac__stream__decoder.html#a17">FLAC__stream_decoder_set_metadata_respond_all</a>().<dl compact><dt><b>

1415

Default Value:</b><dd>

1416

By default, only the <code>STREAMINFO</code> block is returned via the metadata callback. </dl><dl compact><dt><b>

1417

Parameters: </b><dd>

1418

1419

<tr><td valign=top><em>decoder</em> </td><td>

1420

A decoder instance to set. </td></tr>

1421

</table>

1422

</dl><dl compact><dt><b>

1423

Assertions:</b><dd>

1424

<div class="fragment"><pre>decoder != NULL

1425

</pre></div> </dl><dl compact><dt><b>

1426

Return values: </b><dd>

1427

1428

1429

<code>false</code> if the decoder is already initialized, else <code>true</code>. </td></tr>

1430

</table>

1431

</dl> </td>

1432

</tr>

1433

</table>

1434

1435

1436

<tr>

1437

1438

1439

<tr>

1440

<td class="md" nowrap valign="top"> FLAC__bool FLAC__seekable_stream_decoder_set_metadata_ignore </td>

1441

1442

<td class="md" nowrap valign="top"><a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> * </td>

1443

<td class="mdname" nowrap>  <em>decoder</em>, </td>

1444

</tr>

1445

<tr>

1446

1447

1448

<td class="md" nowrap><a class="el" href="group__flac__format.html#a97">FLAC__MetadataType</a> </td>

1449

1450

</tr>

1451

<tr>

1452

1453

1454

1455

</tr>

1456

1457

</table>

1458

</td>

1459

</tr>

1460

</table>

1461

1462

<tr>

1463

<td>

1464

1465

</td>

1466

<td>

1467

1468

<p>

1469

This is inherited from <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a>; see <a class="el" href="group__flac__stream__decoder.html#a18">FLAC__stream_decoder_set_metadata_ignore</a>().<dl compact><dt><b>

1470

Default Value:</b><dd>

1471

By default, only the <code>STREAMINFO</code> block is returned via the metadata callback. </dl><dl compact><dt><b>

1472

Parameters: </b><dd>

1473

1474

<tr><td valign=top><em>decoder</em> </td><td>

1475

A decoder instance to set. </td></tr>

1476

1477

See above. </td></tr>

1478

</table>

1479

</dl><dl compact><dt><b>

1480

Assertions:</b><dd>

1481

<div class="fragment"><pre>decoder != NULL

1482

</pre></div> <em>type</em> is valid </dl><dl compact><dt><b>

1483

Return values: </b><dd>

1484

1485

1486

<code>false</code> if the decoder is already initialized, else <code>true</code>. </td></tr>

1487

</table>

1488

</dl> </td>

1489

</tr>

1490

</table>

1491

1492

1493

<tr>

1494

1495

1496

<tr>

1497

<td class="md" nowrap valign="top"> FLAC__bool FLAC__seekable_stream_decoder_set_metadata_ignore_application </td>

1498

1499

<td class="md" nowrap valign="top"><a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> * </td>

1500

<td class="mdname" nowrap>  <em>decoder</em>, </td>

1501

</tr>

1502

<tr>

1503

1504

1505

<td class="md" nowrap>const FLAC__byte </td>

1506

1507

</tr>

1508

<tr>

1509

1510

1511

1512

</tr>

1513

1514

</table>

1515

</td>

1516

</tr>

1517

</table>

1518

1519

<tr>

1520

<td>

1521

1522

</td>

1523

<td>

1524

1525

<p>

1526

This is inherited from <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a>; see <a class="el" href="group__flac__stream__decoder.html#a19">FLAC__stream_decoder_set_metadata_ignore_application</a>().<dl compact><dt><b>

1527

Default Value:</b><dd>

1528

By default, only the <code>STREAMINFO</code> block is returned via the metadata callback. </dl><dl compact><dt><b>

1529

Parameters: </b><dd>

1530

1531

<tr><td valign=top><em>decoder</em> </td><td>

1532

A decoder instance to set. </td></tr>

1533

1534

See above. </td></tr>

1535

</table>

1536

</dl><dl compact><dt><b>

1537

Assertions:</b><dd>

1538

<div class="fragment"><pre>decoder != NULL

1539

</pre></div> <div class="fragment"><pre>id != NULL

1540

</pre></div> </dl><dl compact><dt><b>

1541

Return values: </b><dd>

1542

1543

1544

<code>false</code> if the decoder is already initialized, else <code>true</code>. </td></tr>

1545

</table>

1546

</dl> </td>

1547

</tr>

1548

</table>

1549

1550

1551

<tr>

1552

1553

1554

<tr>

1555

<td class="md" nowrap valign="top"> FLAC__bool FLAC__seekable_stream_decoder_set_metadata_ignore_all </td>

1556

1557

<td class="md" nowrap valign="top"><a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> * </td>

1558

<td class="mdname1" valign="top" nowrap>  <em>decoder</em> </td>

1559

1560

1561

</tr>

1562

1563

</table>

1564

</td>

1565

</tr>

1566

</table>

1567

1568

<tr>

1569

<td>

1570

1571

</td>

1572

<td>

1573

1574

<p>

1575

This is inherited from <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a>; see <a class="el" href="group__flac__stream__decoder.html#a20">FLAC__stream_decoder_set_metadata_ignore_all</a>().<dl compact><dt><b>

1576

Default Value:</b><dd>

1577

By default, only the <code>STREAMINFO</code> block is returned via the metadata callback. </dl><dl compact><dt><b>

1578

Parameters: </b><dd>

1579

1580

<tr><td valign=top><em>decoder</em> </td><td>

1581

A decoder instance to set. </td></tr>

1582

</table>

1583

</dl><dl compact><dt><b>

1584

Assertions:</b><dd>

1585

<div class="fragment"><pre>decoder != NULL

1586

</pre></div> </dl><dl compact><dt><b>

1587

Return values: </b><dd>

1588

1589

1590

<code>false</code> if the decoder is already initialized, else <code>true</code>. </td></tr>

1591

</table>

1592

</dl> </td>

1593

</tr>

1594

</table>

1595

1596

1597

<tr>

1598

1599

1600

<tr>

1601

<td class="md" nowrap valign="top"> <a class="el" href="group__flac__seekable__stream__decoder.html#a50">FLAC__SeekableStreamDecoderState</a> FLAC__seekable_stream_decoder_get_state </td>

1602

1603

<td class="md" nowrap valign="top">const <a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> * </td>

1604

<td class="mdname1" valign="top" nowrap>  <em>decoder</em> </td>

1605

1606

1607

</tr>

1608

1609

</table>

1610

</td>

1611

</tr>

1612

</table>

1613

1614

<tr>

1615

<td>

1616

1617

</td>

1618

<td>

1619

1620

<p>

1621

Get the current decoder state.<dl compact><dt><b>

1622

Parameters: </b><dd>

1623

1624

<tr><td valign=top><em>decoder</em> </td><td>

1625

A decoder instance to query. </td></tr>

1626

</table>

1627

</dl><dl compact><dt><b>

1628

Assertions:</b><dd>

1629

<div class="fragment"><pre>decoder != NULL

1630

</pre></div> </dl><dl compact><dt><b>

1631

Return values: </b><dd>

1632

1633

<tr><td valign=top><em>FLAC__SeekableStreamDecoderState</em> </td><td>

1634

The current decoder state. </td></tr>

1635

</table>

1636

</dl> </td>

1637

</tr>

1638

</table>

1639

1640

1641

<tr>

1642

1643

1644

<tr>

1645

<td class="md" nowrap valign="top"> <a class="el" href="group__flac__stream__decoder.html#a36">FLAC__StreamDecoderState</a> FLAC__seekable_stream_decoder_get_stream_decoder_state </td>

1646

1647

<td class="md" nowrap valign="top">const <a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> * </td>

1648

<td class="mdname1" valign="top" nowrap>  <em>decoder</em> </td>

1649

1650

1651

</tr>

1652

1653

</table>

1654

</td>

1655

</tr>

1656

</table>

1657

1658

<tr>

1659

<td>

1660

1661

</td>

1662

<td>

1663

1664

<p>

1665

Get the state of the underlying stream decoder. Useful when the seekable stream decoder state is <code>FLAC__SEEKABLE_STREAM_DECODER_STREAM_DECODER_ERROR</code>.<dl compact><dt><b>

1666

Parameters: </b><dd>

1667

1668

<tr><td valign=top><em>decoder</em> </td><td>

1669

A decoder instance to query. </td></tr>

1670

</table>

1671

</dl><dl compact><dt><b>

1672

Assertions:</b><dd>

1673

<div class="fragment"><pre>decoder != NULL

1674

</pre></div> </dl><dl compact><dt><b>

1675

Return values: </b><dd>

1676

1677

<tr><td valign=top><em>FLAC__StreamDecoderState</em> </td><td>

1678

The stream decoder state. </td></tr>

1679

</table>

1680

</dl> </td>

1681

</tr>

1682

</table>

1683

1684

1685

<tr>

1686

1687

1688

<tr>

1689

<td class="md" nowrap valign="top"> const char* FLAC__seekable_stream_decoder_get_resolved_state_string </td>

1690

1691

<td class="md" nowrap valign="top">const <a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> * </td>

1692

<td class="mdname1" valign="top" nowrap>  <em>decoder</em> </td>

1693

1694

1695

</tr>

1696

1697

</table>

1698

</td>

1699

</tr>

1700

</table>

1701

1702

<tr>

1703

<td>

1704

1705

</td>

1706

<td>

1707

1708

<p>

1709

Get the current decoder state as a C string. This version automatically resolves <code>FLAC__SEEKABLE_STREAM_DECODER_STREAM_DECODER_ERROR</code> by getting the stream decoder's state.<dl compact><dt><b>

1710

Parameters: </b><dd>

1711

1712

<tr><td valign=top><em>decoder</em> </td><td>

1713

A decoder instance to query. </td></tr>

1714

</table>

1715

</dl><dl compact><dt><b>

1716

Assertions:</b><dd>

1717

<div class="fragment"><pre>decoder != NULL

1718

</pre></div> </dl><dl compact><dt><b>

1719

Return values: </b><dd>

1720

1721

<tr><td valign=top><em>const</em> </td><td>

1722

char * The decoder state as a C string. Do not modify the contents. </td></tr>

1723

</table>

1724

</dl> </td>

1725

</tr>

1726

</table>

1727

1728

1729

<tr>

1730

1731

1732

<tr>

1733

<td class="md" nowrap valign="top"> FLAC__bool FLAC__seekable_stream_decoder_get_md5_checking </td>

1734

1735

<td class="md" nowrap valign="top">const <a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> * </td>

1736

<td class="mdname1" valign="top" nowrap>  <em>decoder</em> </td>

1737

1738

1739

</tr>

1740

1741

</table>

1742

</td>

1743

</tr>

1744

</table>

1745

1746

<tr>

1747

<td>

1748

1749

</td>

1750

<td>

1751

1752

<p>

1753

Get the "MD5 signature checking" flag. This is the value of the setting, not whether or not the decoder is currently checking the MD5 (remember, it can be turned off automatically by a seek). When the decoder is reset the flag will be restored to the value returned by this function.<dl compact><dt><b>

1754

Parameters: </b><dd>

1755

1756

<tr><td valign=top><em>decoder</em> </td><td>

1757

A decoder instance to query. </td></tr>

1758

</table>

1759

</dl><dl compact><dt><b>

1760

Assertions:</b><dd>

1761

<div class="fragment"><pre>decoder != NULL

1762

</pre></div> </dl><dl compact><dt><b>

1763

Return values: </b><dd>

1764

1765

1766

See above. </td></tr>

1767

</table>

1768

</dl> </td>

1769

</tr>

1770

</table>

1771

1772

1773

<tr>

1774

1775

1776

<tr>

1777

<td class="md" nowrap valign="top"> unsigned FLAC__seekable_stream_decoder_get_channels </td>

1778

1779

<td class="md" nowrap valign="top">const <a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> * </td>

1780

<td class="mdname1" valign="top" nowrap>  <em>decoder</em> </td>

1781

1782

1783

</tr>

1784

1785

</table>

1786

</td>

1787

</tr>

1788

</table>

1789

1790

<tr>

1791

<td>

1792

1793

</td>

1794

<td>

1795

1796

<p>

1797

This is inherited from <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a>; see <a class="el" href="group__flac__stream__decoder.html#a23">FLAC__stream_decoder_get_channels</a>().<dl compact><dt><b>

1798

Parameters: </b><dd>

1799

1800

<tr><td valign=top><em>decoder</em> </td><td>

1801

A decoder instance to query. </td></tr>

1802

</table>

1803

</dl><dl compact><dt><b>

1804

Assertions:</b><dd>

1805

<div class="fragment"><pre>decoder != NULL

1806

</pre></div> </dl><dl compact><dt><b>

1807

Return values: </b><dd>

1808

1809

<tr><td valign=top><em>unsigned</em> </td><td>

1810

See above. </td></tr>

1811

</table>

1812

</dl> </td>

1813

</tr>

1814

</table>

1815

1816

1817

<tr>

1818

1819

1820

<tr>

1821

<td class="md" nowrap valign="top"> <a class="el" href="group__flac__format.html#a95">FLAC__ChannelAssignment</a> FLAC__seekable_stream_decoder_get_channel_assignment </td>

1822

1823

<td class="md" nowrap valign="top">const <a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> * </td>

1824

<td class="mdname1" valign="top" nowrap>  <em>decoder</em> </td>

1825

1826

1827

</tr>

1828

1829

</table>

1830

</td>

1831

</tr>

1832

</table>

1833

1834

<tr>

1835

<td>

1836

1837

</td>

1838

<td>

1839

1840

<p>

1841

This is inherited from <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a>; see <a class="el" href="group__flac__stream__decoder.html#a24">FLAC__stream_decoder_get_channel_assignment</a>().<dl compact><dt><b>

1842

Parameters: </b><dd>

1843

1844

<tr><td valign=top><em>decoder</em> </td><td>

1845

A decoder instance to query. </td></tr>

1846

</table>

1847

</dl><dl compact><dt><b>

1848

Assertions:</b><dd>

1849

<div class="fragment"><pre>decoder != NULL

1850

</pre></div> </dl><dl compact><dt><b>

1851

Return values: </b><dd>

1852

1853

<tr><td valign=top><em>FLAC__ChannelAssignment</em> </td><td>

1854

See above. </td></tr>

1855

</table>

1856

</dl> </td>

1857

</tr>

1858

</table>

1859

1860

1861

<tr>

1862

1863

1864

<tr>

1865

<td class="md" nowrap valign="top"> unsigned FLAC__seekable_stream_decoder_get_bits_per_sample </td>

1866

1867

<td class="md" nowrap valign="top">const <a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> * </td>

1868

<td class="mdname1" valign="top" nowrap>  <em>decoder</em> </td>

1869

1870

1871

</tr>

1872

1873

</table>

1874

</td>

1875

</tr>

1876

</table>

1877

1878

<tr>

1879

<td>

1880

1881

</td>

1882

<td>

1883

1884

<p>

1885

This is inherited from <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a>; see <a class="el" href="group__flac__stream__decoder.html#a25">FLAC__stream_decoder_get_bits_per_sample</a>().<dl compact><dt><b>

1886

Parameters: </b><dd>

1887

1888

<tr><td valign=top><em>decoder</em> </td><td>

1889

A decoder instance to query. </td></tr>

1890

</table>

1891

</dl><dl compact><dt><b>

1892

Assertions:</b><dd>

1893

<div class="fragment"><pre>decoder != NULL

1894

</pre></div> </dl><dl compact><dt><b>

1895

Return values: </b><dd>

1896

1897

<tr><td valign=top><em>unsigned</em> </td><td>

1898

See above. </td></tr>

1899

</table>

1900

</dl> </td>

1901

</tr>

1902

</table>

1903

1904

1905

<tr>

1906

1907

1908

<tr>

1909

<td class="md" nowrap valign="top"> unsigned FLAC__seekable_stream_decoder_get_sample_rate </td>

1910

1911

<td class="md" nowrap valign="top">const <a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> * </td>

1912

<td class="mdname1" valign="top" nowrap>  <em>decoder</em> </td>

1913

1914

1915

</tr>

1916

1917

</table>

1918

</td>

1919

</tr>

1920

</table>

1921

1922

<tr>

1923

<td>

1924

1925

</td>

1926

<td>

1927

1928

<p>

1929

This is inherited from <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a>; see <a class="el" href="group__flac__stream__decoder.html#a26">FLAC__stream_decoder_get_sample_rate</a>().<dl compact><dt><b>

1930

Parameters: </b><dd>

1931

1932

<tr><td valign=top><em>decoder</em> </td><td>

1933

A decoder instance to query. </td></tr>

1934

</table>

1935

</dl><dl compact><dt><b>

1936

Assertions:</b><dd>

1937

<div class="fragment"><pre>decoder != NULL

1938

</pre></div> </dl><dl compact><dt><b>

1939

Return values: </b><dd>

1940

1941

<tr><td valign=top><em>unsigned</em> </td><td>

1942

See above. </td></tr>

1943

</table>

1944

</dl> </td>

1945

</tr>

1946

</table>

1947

1948

1949

<tr>

1950

1951

1952

<tr>

1953

<td class="md" nowrap valign="top"> unsigned FLAC__seekable_stream_decoder_get_blocksize </td>

1954

1955

<td class="md" nowrap valign="top">const <a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> * </td>

1956

<td class="mdname1" valign="top" nowrap>  <em>decoder</em> </td>

1957

1958

1959

</tr>

1960

1961

</table>

1962

</td>

1963

</tr>

1964

</table>

1965

1966

<tr>

1967

<td>

1968

1969

</td>

1970

<td>

1971

1972

<p>

1973

This is inherited from <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a>; see <a class="el" href="group__flac__stream__decoder.html#a27">FLAC__stream_decoder_get_blocksize</a>().<dl compact><dt><b>

1974

Parameters: </b><dd>

1975

1976

<tr><td valign=top><em>decoder</em> </td><td>

1977

A decoder instance to query. </td></tr>

1978

</table>

1979

</dl><dl compact><dt><b>

1980

Assertions:</b><dd>

1981

<div class="fragment"><pre>decoder != NULL

1982

</pre></div> </dl><dl compact><dt><b>

1983

Return values: </b><dd>

1984

1985

<tr><td valign=top><em>unsigned</em> </td><td>

1986

See above. </td></tr>

1987

</table>

1988

</dl> </td>

1989

</tr>

1990

</table>

1991

1992

1993

<tr>

1994

1995

1996

<tr>

1997

<td class="md" nowrap valign="top"> FLAC__bool FLAC__seekable_stream_decoder_get_decode_position </td>

1998

1999

<td class="md" nowrap valign="top">const <a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> * </td>

2000

<td class="mdname" nowrap>  <em>decoder</em>, </td>

2001

</tr>

2002

<tr>

2003

2004

2005

2006

<td class="mdname" nowrap>  <em>position</em></td>

2007

</tr>

2008

<tr>

2009

2010

2011

2012

</tr>

2013

2014

</table>

2015

</td>

2016

</tr>

2017

</table>

2018

2019

<tr>

2020

<td>

2021

2022

</td>

2023

<td>

2024

2025

<p>

2026

Returns the decoder's current read position within the stream. The position is the byte offset from the start of the stream. Bytes before this position have been fully decoded. Note that there may still be undecoded bytes in the decoder's read FIFO. The returned position is correct even after a seek.<dl compact><dt><b>

2027

Parameters: </b><dd>

2028

2029

<tr><td valign=top><em>decoder</em> </td><td>

2030

A decoder instance to query. </td></tr>

2031

<tr><td valign=top><em>position</em> </td><td>

2032

Address at which to return the desired position. </td></tr>

2033

</table>

2034

</dl><dl compact><dt><b>

2035

Assertions:</b><dd>

2036

<div class="fragment"><pre>decoder != NULL

2037

</pre></div> <div class="fragment"><pre>position != NULL

2038

</pre></div> </dl><dl compact><dt><b>

2039

Return values: </b><dd>

2040

2041

2042

<code>true</code> if successful, <code>false</code> if there was an error from the 'tell' callback. </td></tr>

2043

</table>

2044

</dl> </td>

2045

</tr>

2046

</table>

2047

2048

2049

<tr>

2050

2051

2052

<tr>

2053

<td class="md" nowrap valign="top"> <a class="el" href="group__flac__seekable__stream__decoder.html#a50">FLAC__SeekableStreamDecoderState</a> FLAC__seekable_stream_decoder_init </td>

2054

2055

<td class="md" nowrap valign="top"><a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> * </td>

2056

<td class="mdname1" valign="top" nowrap>  <em>decoder</em> </td>

2057

2058

2059

</tr>

2060

2061

</table>

2062

</td>

2063

</tr>

2064

</table>

2065

2066

<tr>

2067

<td>

2068

2069

</td>

2070

<td>

2071

2072

<p>

2073

Initialize the decoder instance. Should be called after <a class="el" href="group__flac__seekable__stream__decoder.html#a13">FLAC__seekable_stream_decoder_new</a>() and FLAC__seekable_stream_decoder_set_*() but before any of the FLAC__seekable_stream_decoder_process_*() functions. Will set and return the decoder state, which will be FLAC__SEEKABLE_STREAM_DECODER_OK if initialization succeeded.<dl compact><dt><b>

2074

Parameters: </b><dd>

2075

2076

<tr><td valign=top><em>decoder</em> </td><td>

2077

An uninitialized decoder instance. </td></tr>

2078

</table>

2079

</dl><dl compact><dt><b>

2080

Assertions:</b><dd>

2081

<div class="fragment"><pre>decoder != NULL

2082

</pre></div> </dl><dl compact><dt><b>

2083

Return values: </b><dd>

2084

2085

<tr><td valign=top><em>FLAC__SeekableStreamDecoderState</em> </td><td>

2086

<code>FLAC__SEEKABLE_STREAM_DECODER_OK</code> if initialization was successful; see FLAC__SeekableStreamDecoderState for the meanings of other return values. </td></tr>

2087

</table>

2088

</dl> </td>

2089

</tr>

2090

</table>

2091

2092

2093

<tr>

2094

2095

2096

<tr>

2097

<td class="md" nowrap valign="top"> FLAC__bool FLAC__seekable_stream_decoder_finish </td>

2098

2099

<td class="md" nowrap valign="top"><a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> * </td>

2100

<td class="mdname1" valign="top" nowrap>  <em>decoder</em> </td>

2101

2102

2103

</tr>

2104

2105

</table>

2106

</td>

2107

</tr>

2108

</table>

2109

2110

<tr>

2111

<td>

2112

2113

</td>

2114

<td>

2115

2116

<p>

2117

Finish the decoding process. Flushes the decoding buffer, releases resources, resets the decoder settings to their defaults, and returns the decoder state to FLAC__SEEKABLE_STREAM_DECODER_UNINITIALIZED.

2118

<p>

2119

In the event of a prematurely-terminated decode, it is not strictly necessary to call this immediately before <a class="el" href="group__flac__seekable__stream__decoder.html#a14">FLAC__seekable_stream_decoder_delete</a>() but it is good practice to match every <a class="el" href="group__flac__seekable__stream__decoder.html#a41">FLAC__seekable_stream_decoder_init</a>() with a <a class="el" href="group__flac__seekable__stream__decoder.html#a42">FLAC__seekable_stream_decoder_finish</a>().<dl compact><dt><b>

2120

Parameters: </b><dd>

2121

2122

<tr><td valign=top><em>decoder</em> </td><td>

2123

An uninitialized decoder instance. </td></tr>

2124

</table>

2125

</dl><dl compact><dt><b>

2126

Assertions:</b><dd>

2127

<div class="fragment"><pre>decoder != NULL

2128

</pre></div> </dl><dl compact><dt><b>

2129

Return values: </b><dd>

2130

2131

2132

<code>false</code> if MD5 checking is on AND a STREAMINFO block was available AND the MD5 signature in the STREAMINFO block was non-zero AND the signature does not match the one computed by the decoder; else <code>true</code>. </td></tr>

2133

</table>

2134

</dl> </td>

2135

</tr>

2136

</table>

2137

2138

2139

<tr>

2140

2141

2142

<tr>

2143

<td class="md" nowrap valign="top"> FLAC__bool FLAC__seekable_stream_decoder_flush </td>

2144

2145

<td class="md" nowrap valign="top"><a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> * </td>

2146

<td class="mdname1" valign="top" nowrap>  <em>decoder</em> </td>

2147

2148

2149

</tr>

2150

2151

</table>

2152

</td>

2153

</tr>

2154

</table>

2155

2156

<tr>

2157

<td>

2158

2159

</td>

2160

<td>

2161

2162

<p>

2163

Flush the stream input. The decoder's input buffer will be cleared and the state set to <code>FLAC__SEEKABLE_STREAM_DECODER_OK</code>. This will also turn off MD5 checking.<dl compact><dt><b>

2164

Parameters: </b><dd>

2165

2166

<tr><td valign=top><em>decoder</em> </td><td>

2167

A decoder instance. </td></tr>

2168

</table>

2169

</dl><dl compact><dt><b>

2170

Assertions:</b><dd>

2171

<div class="fragment"><pre>decoder != NULL

2172

</pre></div> </dl><dl compact><dt><b>

2173

Return values: </b><dd>

2174

2175

2176

<code>true</code> if successful, else <code>false</code> if a memory allocation or stream decoder error occurs. </td></tr>

2177

</table>

2178

</dl> </td>

2179

</tr>

2180

</table>

2181

2182

2183

<tr>

2184

2185

2186

<tr>

2187

<td class="md" nowrap valign="top"> FLAC__bool FLAC__seekable_stream_decoder_reset </td>

2188

2189

<td class="md" nowrap valign="top"><a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> * </td>

2190

<td class="mdname1" valign="top" nowrap>  <em>decoder</em> </td>

2191

2192

2193

</tr>

2194

2195

</table>

2196

</td>

2197

</tr>

2198

</table>

2199

2200

<tr>

2201

<td>

2202

2203

</td>

2204

<td>

2205

2206

<p>

2207

Reset the decoding process. The decoder's input buffer will be cleared and the state set to <code>FLAC__SEEKABLE_STREAM_DECODER_OK</code>. This is similar to <a class="el" href="group__flac__seekable__stream__decoder.html#a42">FLAC__seekable_stream_decoder_finish</a>() except that the settings are preserved; there is no need to call <a class="el" href="group__flac__seekable__stream__decoder.html#a41">FLAC__seekable_stream_decoder_init</a>() before decoding again. MD5 checking will be restored to its original setting.<dl compact><dt><b>

2208

Parameters: </b><dd>

2209

2210

<tr><td valign=top><em>decoder</em> </td><td>

2211

A decoder instance. </td></tr>

2212

</table>

2213

</dl><dl compact><dt><b>

2214

Assertions:</b><dd>

2215

<div class="fragment"><pre>decoder != NULL

2216

</pre></div> </dl><dl compact><dt><b>

2217

Return values: </b><dd>

2218

2219

2220

<code>true</code> if successful, else <code>false</code> if a memory allocation or stream decoder error occurs. </td></tr>

2221

</table>

2222

</dl> </td>

2223

</tr>

2224

</table>

2225

2226

2227

<tr>

2228

2229

2230

<tr>

2231

<td class="md" nowrap valign="top"> FLAC__bool FLAC__seekable_stream_decoder_process_single </td>

2232

2233

<td class="md" nowrap valign="top"><a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> * </td>

2234

<td class="mdname1" valign="top" nowrap>  <em>decoder</em> </td>

2235

2236

2237

</tr>

2238

2239

</table>

2240

</td>

2241

</tr>

2242

</table>

2243

2244

<tr>

2245

<td>

2246

2247

</td>

2248

<td>

2249

2250

<p>

2251

This is inherited from <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a>; see <a class="el" href="group__flac__stream__decoder.html#a32">FLAC__stream_decoder_process_single</a>().<dl compact><dt><b>

2252

Parameters: </b><dd>

2253

2254

<tr><td valign=top><em>decoder</em> </td><td>

2255

A decoder instance. </td></tr>

2256

</table>

2257

</dl><dl compact><dt><b>

2258

Assertions:</b><dd>

2259

<div class="fragment"><pre>decoder != NULL

2260

</pre></div> </dl><dl compact><dt><b>

2261

Return values: </b><dd>

2262

2263

2264

See above. </td></tr>

2265

</table>

2266

</dl> </td>

2267

</tr>

2268

</table>

2269

2270

2271

<tr>

2272

2273

2274

<tr>

2275

<td class="md" nowrap valign="top"> FLAC__bool FLAC__seekable_stream_decoder_process_until_end_of_metadata </td>

2276

2277

<td class="md" nowrap valign="top"><a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> * </td>

2278

<td class="mdname1" valign="top" nowrap>  <em>decoder</em> </td>

2279

2280

2281

</tr>

2282

2283

</table>

2284

</td>

2285

</tr>

2286

</table>

2287

2288

<tr>

2289

<td>

2290

2291

</td>

2292

<td>

2293

2294

<p>

2295

This is inherited from <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a>; see <a class="el" href="group__flac__stream__decoder.html#a33">FLAC__stream_decoder_process_until_end_of_metadata</a>().<dl compact><dt><b>

2296

Parameters: </b><dd>

2297

2298

<tr><td valign=top><em>decoder</em> </td><td>

2299

A decoder instance. </td></tr>

2300

</table>

2301

</dl><dl compact><dt><b>

2302

Assertions:</b><dd>

2303

<div class="fragment"><pre>decoder != NULL

2304

</pre></div> </dl><dl compact><dt><b>

2305

Return values: </b><dd>

2306

2307

2308

See above. </td></tr>

2309

</table>

2310

</dl> </td>

2311

</tr>

2312

</table>

2313

2314

2315

<tr>

2316

2317

2318

<tr>

2319

<td class="md" nowrap valign="top"> FLAC__bool FLAC__seekable_stream_decoder_process_until_end_of_stream </td>

2320

2321

<td class="md" nowrap valign="top"><a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> * </td>

2322

<td class="mdname1" valign="top" nowrap>  <em>decoder</em> </td>

2323

2324

2325

</tr>

2326

2327

</table>

2328

</td>

2329

</tr>

2330

</table>

2331

2332

<tr>

2333

<td>

2334

2335

</td>

2336

<td>

2337

2338

<p>

2339

This is inherited from <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a>; see <a class="el" href="group__flac__stream__decoder.html#a34">FLAC__stream_decoder_process_until_end_of_stream</a>().<dl compact><dt><b>

2340

Parameters: </b><dd>

2341

2342

<tr><td valign=top><em>decoder</em> </td><td>

2343

A decoder instance. </td></tr>

2344

</table>

2345

</dl><dl compact><dt><b>

2346

Assertions:</b><dd>

2347

<div class="fragment"><pre>decoder != NULL

2348

</pre></div> </dl><dl compact><dt><b>

2349

Return values: </b><dd>

2350

2351

2352

See above. </td></tr>

2353

</table>

2354

</dl> </td>

2355

</tr>

2356

</table>

2357

2358

2359

<tr>

2360

2361

2362

<tr>

2363

<td class="md" nowrap valign="top"> FLAC__bool FLAC__seekable_stream_decoder_skip_single_frame </td>

2364

2365

<td class="md" nowrap valign="top"><a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> * </td>

2366

<td class="mdname1" valign="top" nowrap>  <em>decoder</em> </td>

2367

2368

2369

</tr>

2370

2371

</table>

2372

</td>

2373

</tr>

2374

</table>

2375

2376

<tr>

2377

<td>

2378

2379

</td>

2380

<td>

2381

2382

<p>

2383

This is inherited from <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a>; see <a class="el" href="group__flac__stream__decoder.html#a35">FLAC__stream_decoder_skip_single_frame</a>().<dl compact><dt><b>

2384

Parameters: </b><dd>

2385

2386

<tr><td valign=top><em>decoder</em> </td><td>

2387

A decoder instance. </td></tr>

2388

</table>

2389

</dl><dl compact><dt><b>

2390

Assertions:</b><dd>

2391

<div class="fragment"><pre>decoder != NULL

2392

</pre></div> </dl><dl compact><dt><b>

2393

Return values: </b><dd>

2394

2395

2396

See above. </td></tr>

2397

</table>

2398

</dl> </td>

2399

</tr>

2400

</table>

2401

2402

2403

<tr>

2404

2405

2406

<tr>

2407

<td class="md" nowrap valign="top"> FLAC__bool FLAC__seekable_stream_decoder_seek_absolute </td>

2408

2409

<td class="md" nowrap valign="top"><a class="el" href="structFLAC____SeekableStreamDecoder.html">FLAC__SeekableStreamDecoder</a> * </td>

2410

<td class="mdname" nowrap>  <em>decoder</em>, </td>

2411

</tr>

2412

<tr>

2413

2414

2415

2416

<td class="mdname" nowrap>  <em>sample</em></td>

2417

</tr>

2418

<tr>

2419

2420

2421

2422

</tr>

2423

2424

</table>

2425

</td>

2426

</tr>

2427

</table>

2428

2429

<tr>

2430

<td>

2431

2432

</td>

2433

<td>

2434

2435

<p>

2436

Flush the input and seek to an absolute sample. Decoding will resume at the given sample. Note that because of this, the next write callback may contain a partial block.<dl compact><dt><b>

2437

Parameters: </b><dd>

2438

2439

<tr><td valign=top><em>decoder</em> </td><td>

2440

A decoder instance. </td></tr>

2441

<tr><td valign=top><em>sample</em> </td><td>

2442

The target sample number to seek to. </td></tr>

2443

</table>

2444

</dl><dl compact><dt><b>

2445

Assertions:</b><dd>

2446

<div class="fragment"><pre>decoder != NULL

2447

</pre></div> </dl><dl compact><dt><b>

2448

Return values: </b><dd>

2449

2450

2451

<code>true</code> if successful, else <code>false</code>. </td></tr>

2452

</table>

2453

</dl> </td>

2454

</tr>

2455

</table>

2456

<hr><h2>Variable Documentation</h2>

2457

2458

2459

<tr>

2460

2461

2462

<tr>

2463

<td class="md" nowrap valign="top"> const char* const FLAC__SeekableStreamDecoderStateString[]

2464

</table>

2465

</td>

2466

</tr>

2467

</table>

2468

2469

<tr>

2470

<td>

2471

2472

</td>

2473

<td>

2474

2475

<p>

2476

Maps a FLAC__SeekableStreamDecoderState to a C string.

2477

<p>

2478

Using a FLAC__SeekableStreamDecoderState as the index to this array will give the string equivalent. The contents should not be modified. </td>

2479

</tr>

2480

</table>

2481

2482

2483

<tr>

2484

2485

2486

<tr>

2487

<td class="md" nowrap valign="top"> const char* const FLAC__SeekableStreamDecoderReadStatusString[]

2488

</table>

2489

</td>

2490

</tr>

2491

</table>

2492

2493

<tr>

2494

<td>

2495

2496

</td>

2497

<td>

2498

2499

<p>

2500

Maps a FLAC__SeekableStreamDecoderReadStatus to a C string.

2501

<p>

2502

Using a FLAC__SeekableStreamDecoderReadStatus as the index to this array will give the string equivalent. The contents should not be modified. </td>

2503

</tr>

2504

</table>

2505

2506

2507

<tr>

2508

2509

2510

<tr>

2511

<td class="md" nowrap valign="top"> const char* const FLAC__SeekableStreamDecoderSeekStatusString[]

2512

</table>

2513

</td>

2514

</tr>

2515

</table>

2516

2517

<tr>

2518

<td>

2519

2520

</td>

2521

<td>

2522

2523

<p>

2524

Maps a FLAC__SeekableStreamDecoderSeekStatus to a C string.

2525

<p>

2526

Using a FLAC__SeekableStreamDecoderSeekStatus as the index to this array will give the string equivalent. The contents should not be modified. </td>

2527

</tr>

2528

</table>

2529

2530

2531

<tr>

2532

2533

2534

<tr>

2535

<td class="md" nowrap valign="top"> const char* const FLAC__SeekableStreamDecoderTellStatusString[]

2536

</table>

2537

</td>

2538

</tr>

2539

</table>

2540

2541

<tr>

2542

<td>

2543

2544

</td>

2545

<td>

2546

2547

<p>

2548

Maps a FLAC__SeekableStreamDecoderTellStatus to a C string.

2549

<p>

2550

Using a FLAC__SeekableStreamDecoderTellStatus as the index to this array will give the string equivalent. The contents should not be modified. </td>

2551

</tr>

2552

</table>

2553

2554

2555

<tr>

2556

2557

2558

<tr>

2559

<td class="md" nowrap valign="top"> const char* const FLAC__SeekableStreamDecoderLengthStatusString[]

2560

</table>

2561

</td>

2562

</tr>

2563

</table>

2564

2565

<tr>

2566

<td>

2567

2568

</td>

2569

<td>

2570

2571

<p>

2572

Maps a FLAC__SeekableStreamDecoderLengthStatus to a C string.

2573

<p>

2574

Using a FLAC__SeekableStreamDecoderLengthStatus as the index to this array will give the string equivalent. The contents should not be modified. </td>

2575

</tr>

2576

</table>

2577

<hr><address><small>Generated on Fri Feb 4 18:39:16 2005 for FLAC by

2578

2579

<img src="doxygen.gif" alt="doxygen" align="middle" border=0

2580

width=110 height=53></a>1.2.14 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>,

2581

2582

</body>

2583

</html>

Older »