~ubuntu-branches/ubuntu/gutsy/flac/gutsy-updates

« back to all changes in this revision

Viewing changes to doc/html/api/group__oggflac__stream__decoder.html

  • Committer: Bazaar Package Importer
  • Author(s): Matt Zimmerman
  • Date: 2004-04-16 15:14:31 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20040416151431-eyloggqxpwbwpogz
Tags: 1.1.0-11
Ensure that libFLAC is linked with -lm on all architectures, and
regardless of whether nasm is present

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
 
2
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
 
3
<title>OggFLAC/stream_decoder.h: stream decoder interface</title>
 
4
<link href="doxygen.css" rel="stylesheet" type="text/css">
 
5
</head><body>
 
6
<!-- Generated by Doxygen 1.2.14 -->
 
7
<center>
 
8
<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="modules.html">Modules</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
 
9
<hr><h1>OggFLAC/stream_decoder.h: stream decoder interface<br>
 
10
<small>
 
11
[<a class="el" href="group__oggflac__decoder.html">OggFLAC/_decoder.h: decoder interfaces</a>]</small>
 
12
</h1>This module contains the functions which implement the stream decoder. 
 
13
<a href="#_details">More...</a><table border=0 cellpadding=0 cellspacing=0>
 
14
<tr><td colspan=2><br><h2>Compounds</h2></td></tr>
 
15
<tr><td nowrap align=right valign=top>struct &nbsp;</td><td valign=bottom><a class="el" href="structOggFLAC____StreamDecoder.html">OggFLAC__StreamDecoder</a></td></tr>
 
16
<tr><td colspan=2><br><h2>Typedefs</h2></td></tr>
 
17
<tr><td nowrap align=right valign=top>typedef <a class="el" href="group__flac__stream__decoder.html#a35">FLAC__StreamDecoderReadStatus</a>(*&nbsp;</td><td valign=bottom><a class="el" href="group__oggflac__stream__decoder.html#a1">OggFLAC__StreamDecoderReadCallback</a> )(const <a class="el" href="structOggFLAC____StreamDecoder.html">OggFLAC__StreamDecoder</a> *decoder, FLAC__byte buffer[], unsigned *bytes, void *client_data)</td></tr>
 
18
<tr><td nowrap align=right valign=top>typedef <a class="el" href="group__flac__stream__decoder.html#a36">FLAC__StreamDecoderWriteStatus</a>(*&nbsp;</td><td valign=bottom><a class="el" href="group__oggflac__stream__decoder.html#a2">OggFLAC__StreamDecoderWriteCallback</a> )(const <a class="el" href="structOggFLAC____StreamDecoder.html">OggFLAC__StreamDecoder</a> *decoder, const <a class="el" href="structFLAC____Frame.html">FLAC__Frame</a> *frame, const FLAC__int32 *const buffer[], void *client_data)</td></tr>
 
19
<tr><td nowrap align=right valign=top>typedef void(*&nbsp;</td><td valign=bottom><a class="el" href="group__oggflac__stream__decoder.html#a3">OggFLAC__StreamDecoderMetadataCallback</a> )(const <a class="el" href="structOggFLAC____StreamDecoder.html">OggFLAC__StreamDecoder</a> *decoder, const <a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> *metadata, void *client_data)</td></tr>
 
20
<tr><td nowrap align=right valign=top>typedef void(*&nbsp;</td><td valign=bottom><a class="el" href="group__oggflac__stream__decoder.html#a4">OggFLAC__StreamDecoderErrorCallback</a> )(const <a class="el" href="structOggFLAC____StreamDecoder.html">OggFLAC__StreamDecoder</a> *decoder, <a class="el" href="group__flac__stream__decoder.html#a37">FLAC__StreamDecoderErrorStatus</a> status, void *client_data)</td></tr>
 
21
<tr><td colspan=2><br><h2>Enumerations</h2></td></tr>
 
22
<tr><td nowrap align=right valign=top>enum &nbsp;</td><td valign=bottom><a class="el" href="group__oggflac__stream__decoder.html#a33">OggFLAC__StreamDecoderState</a> { <br>
 
23
&nbsp;&nbsp;<a class="el" href="group__oggflac__stream__decoder.html#a33a5">OggFLAC__STREAM_DECODER_OK</a> =  0, 
 
24
<a class="el" href="group__oggflac__stream__decoder.html#a33a6">OggFLAC__STREAM_DECODER_OGG_ERROR</a>, 
 
25
<a class="el" href="group__oggflac__stream__decoder.html#a33a7">OggFLAC__STREAM_DECODER_READ_ERROR</a>, 
 
26
<a class="el" href="group__oggflac__stream__decoder.html#a33a8">OggFLAC__STREAM_DECODER_FLAC_STREAM_DECODER_ERROR</a>, 
 
27
<br>
 
28
&nbsp;&nbsp;<a class="el" href="group__oggflac__stream__decoder.html#a33a9">OggFLAC__STREAM_DECODER_INVALID_CALLBACK</a>, 
 
29
<a class="el" href="group__oggflac__stream__decoder.html#a33a10">OggFLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR</a>, 
 
30
<a class="el" href="group__oggflac__stream__decoder.html#a33a11">OggFLAC__STREAM_DECODER_ALREADY_INITIALIZED</a>, 
 
31
<a class="el" href="group__oggflac__stream__decoder.html#a33a12">OggFLAC__STREAM_DECODER_UNINITIALIZED</a>
 
32
<br>
 
33
 }</td></tr>
 
34
<tr><td colspan=2><br><h2>Functions</h2></td></tr>
 
35
<tr><td nowrap align=right valign=top>OggFLAC_API <a class="el" href="structOggFLAC____StreamDecoder.html">OggFLAC__StreamDecoder</a> *&nbsp;</td><td valign=bottom><a class="el" href="group__oggflac__stream__decoder.html#a5">OggFLAC__stream_decoder_new</a> ()</td></tr>
 
36
<tr><td nowrap align=right valign=top>OggFLAC_API void&nbsp;</td><td valign=bottom><a class="el" href="group__oggflac__stream__decoder.html#a6">OggFLAC__stream_decoder_delete</a> (<a class="el" href="structOggFLAC____StreamDecoder.html">OggFLAC__StreamDecoder</a> *decoder)</td></tr>
 
37
<tr><td nowrap align=right valign=top>OggFLAC_API FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__oggflac__stream__decoder.html#a7">OggFLAC__stream_decoder_set_read_callback</a> (<a class="el" href="structOggFLAC____StreamDecoder.html">OggFLAC__StreamDecoder</a> *decoder, <a class="el" href="group__oggflac__stream__decoder.html#a1">OggFLAC__StreamDecoderReadCallback</a> value)</td></tr>
 
38
<tr><td nowrap align=right valign=top>OggFLAC_API FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__oggflac__stream__decoder.html#a8">OggFLAC__stream_decoder_set_write_callback</a> (<a class="el" href="structOggFLAC____StreamDecoder.html">OggFLAC__StreamDecoder</a> *decoder, <a class="el" href="group__oggflac__stream__decoder.html#a2">OggFLAC__StreamDecoderWriteCallback</a> value)</td></tr>
 
39
<tr><td nowrap align=right valign=top>OggFLAC_API FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__oggflac__stream__decoder.html#a9">OggFLAC__stream_decoder_set_metadata_callback</a> (<a class="el" href="structOggFLAC____StreamDecoder.html">OggFLAC__StreamDecoder</a> *decoder, <a class="el" href="group__oggflac__stream__decoder.html#a3">OggFLAC__StreamDecoderMetadataCallback</a> value)</td></tr>
 
40
<tr><td nowrap align=right valign=top>OggFLAC_API FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__oggflac__stream__decoder.html#a10">OggFLAC__stream_decoder_set_error_callback</a> (<a class="el" href="structOggFLAC____StreamDecoder.html">OggFLAC__StreamDecoder</a> *decoder, <a class="el" href="group__oggflac__stream__decoder.html#a4">OggFLAC__StreamDecoderErrorCallback</a> value)</td></tr>
 
41
<tr><td nowrap align=right valign=top>OggFLAC_API FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__oggflac__stream__decoder.html#a11">OggFLAC__stream_decoder_set_client_data</a> (<a class="el" href="structOggFLAC____StreamDecoder.html">OggFLAC__StreamDecoder</a> *decoder, void *value)</td></tr>
 
42
<tr><td nowrap align=right valign=top>OggFLAC_API FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__oggflac__stream__decoder.html#a12">OggFLAC__stream_decoder_set_serial_number</a> (<a class="el" href="structOggFLAC____StreamDecoder.html">OggFLAC__StreamDecoder</a> *decoder, long serial_number)</td></tr>
 
43
<tr><td nowrap align=right valign=top>OggFLAC_API FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__oggflac__stream__decoder.html#a13">OggFLAC__stream_decoder_set_metadata_respond</a> (<a class="el" href="structOggFLAC____StreamDecoder.html">OggFLAC__StreamDecoder</a> *decoder, <a class="el" href="group__flac__format.html#a93">FLAC__MetadataType</a> type)</td></tr>
 
44
<tr><td nowrap align=right valign=top>OggFLAC_API FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__oggflac__stream__decoder.html#a14">OggFLAC__stream_decoder_set_metadata_respond_application</a> (<a class="el" href="structOggFLAC____StreamDecoder.html">OggFLAC__StreamDecoder</a> *decoder, const FLAC__byte id[4])</td></tr>
 
45
<tr><td nowrap align=right valign=top>OggFLAC_API FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__oggflac__stream__decoder.html#a15">OggFLAC__stream_decoder_set_metadata_respond_all</a> (<a class="el" href="structOggFLAC____StreamDecoder.html">OggFLAC__StreamDecoder</a> *decoder)</td></tr>
 
46
<tr><td nowrap align=right valign=top>OggFLAC_API FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__oggflac__stream__decoder.html#a16">OggFLAC__stream_decoder_set_metadata_ignore</a> (<a class="el" href="structOggFLAC____StreamDecoder.html">OggFLAC__StreamDecoder</a> *decoder, <a class="el" href="group__flac__format.html#a93">FLAC__MetadataType</a> type)</td></tr>
 
47
<tr><td nowrap align=right valign=top>OggFLAC_API FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__oggflac__stream__decoder.html#a17">OggFLAC__stream_decoder_set_metadata_ignore_application</a> (<a class="el" href="structOggFLAC____StreamDecoder.html">OggFLAC__StreamDecoder</a> *decoder, const FLAC__byte id[4])</td></tr>
 
48
<tr><td nowrap align=right valign=top>OggFLAC_API FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__oggflac__stream__decoder.html#a18">OggFLAC__stream_decoder_set_metadata_ignore_all</a> (<a class="el" href="structOggFLAC____StreamDecoder.html">OggFLAC__StreamDecoder</a> *decoder)</td></tr>
 
49
<tr><td nowrap align=right valign=top>OggFLAC_API <a class="el" href="group__oggflac__stream__decoder.html#a33">OggFLAC__StreamDecoderState</a>&nbsp;</td><td valign=bottom><a class="el" href="group__oggflac__stream__decoder.html#a19">OggFLAC__stream_decoder_get_state</a> (const <a class="el" href="structOggFLAC____StreamDecoder.html">OggFLAC__StreamDecoder</a> *decoder)</td></tr>
 
50
<tr><td nowrap align=right valign=top>OggFLAC_API <a class="el" href="group__flac__stream__decoder.html#a34">FLAC__StreamDecoderState</a>&nbsp;</td><td valign=bottom><a class="el" href="group__oggflac__stream__decoder.html#a20">OggFLAC__stream_decoder_get_FLAC_stream_decoder_state</a> (const <a class="el" href="structOggFLAC____StreamDecoder.html">OggFLAC__StreamDecoder</a> *decoder)</td></tr>
 
51
<tr><td nowrap align=right valign=top>OggFLAC_API unsigned&nbsp;</td><td valign=bottom><a class="el" href="group__oggflac__stream__decoder.html#a21">OggFLAC__stream_decoder_get_channels</a> (const <a class="el" href="structOggFLAC____StreamDecoder.html">OggFLAC__StreamDecoder</a> *decoder)</td></tr>
 
52
<tr><td nowrap align=right valign=top>OggFLAC_API <a class="el" href="group__flac__format.html#a91">FLAC__ChannelAssignment</a>&nbsp;</td><td valign=bottom><a class="el" href="group__oggflac__stream__decoder.html#a22">OggFLAC__stream_decoder_get_channel_assignment</a> (const <a class="el" href="structOggFLAC____StreamDecoder.html">OggFLAC__StreamDecoder</a> *decoder)</td></tr>
 
53
<tr><td nowrap align=right valign=top>OggFLAC_API unsigned&nbsp;</td><td valign=bottom><a class="el" href="group__oggflac__stream__decoder.html#a23">OggFLAC__stream_decoder_get_bits_per_sample</a> (const <a class="el" href="structOggFLAC____StreamDecoder.html">OggFLAC__StreamDecoder</a> *decoder)</td></tr>
 
54
<tr><td nowrap align=right valign=top>OggFLAC_API unsigned&nbsp;</td><td valign=bottom><a class="el" href="group__oggflac__stream__decoder.html#a24">OggFLAC__stream_decoder_get_sample_rate</a> (const <a class="el" href="structOggFLAC____StreamDecoder.html">OggFLAC__StreamDecoder</a> *decoder)</td></tr>
 
55
<tr><td nowrap align=right valign=top>OggFLAC_API unsigned&nbsp;</td><td valign=bottom><a class="el" href="group__oggflac__stream__decoder.html#a25">OggFLAC__stream_decoder_get_blocksize</a> (const <a class="el" href="structOggFLAC____StreamDecoder.html">OggFLAC__StreamDecoder</a> *decoder)</td></tr>
 
56
<tr><td nowrap align=right valign=top>OggFLAC_API <a class="el" href="group__oggflac__stream__decoder.html#a33">OggFLAC__StreamDecoderState</a>&nbsp;</td><td valign=bottom><a class="el" href="group__oggflac__stream__decoder.html#a26">OggFLAC__stream_decoder_init</a> (<a class="el" href="structOggFLAC____StreamDecoder.html">OggFLAC__StreamDecoder</a> *decoder)</td></tr>
 
57
<tr><td nowrap align=right valign=top>OggFLAC_API void&nbsp;</td><td valign=bottom><a class="el" href="group__oggflac__stream__decoder.html#a27">OggFLAC__stream_decoder_finish</a> (<a class="el" href="structOggFLAC____StreamDecoder.html">OggFLAC__StreamDecoder</a> *decoder)</td></tr>
 
58
<tr><td nowrap align=right valign=top>OggFLAC_API FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__oggflac__stream__decoder.html#a28">OggFLAC__stream_decoder_flush</a> (<a class="el" href="structOggFLAC____StreamDecoder.html">OggFLAC__StreamDecoder</a> *decoder)</td></tr>
 
59
<tr><td nowrap align=right valign=top>OggFLAC_API FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__oggflac__stream__decoder.html#a29">OggFLAC__stream_decoder_reset</a> (<a class="el" href="structOggFLAC____StreamDecoder.html">OggFLAC__StreamDecoder</a> *decoder)</td></tr>
 
60
<tr><td nowrap align=right valign=top>OggFLAC_API FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__oggflac__stream__decoder.html#a30">OggFLAC__stream_decoder_process_single</a> (<a class="el" href="structOggFLAC____StreamDecoder.html">OggFLAC__StreamDecoder</a> *decoder)</td></tr>
 
61
<tr><td nowrap align=right valign=top>OggFLAC_API FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__oggflac__stream__decoder.html#a31">OggFLAC__stream_decoder_process_until_end_of_metadata</a> (<a class="el" href="structOggFLAC____StreamDecoder.html">OggFLAC__StreamDecoder</a> *decoder)</td></tr>
 
62
<tr><td nowrap align=right valign=top>OggFLAC_API FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__oggflac__stream__decoder.html#a32">OggFLAC__stream_decoder_process_until_end_of_stream</a> (<a class="el" href="structOggFLAC____StreamDecoder.html">OggFLAC__StreamDecoder</a> *decoder)</td></tr>
 
63
<tr><td colspan=2><br><h2>Variables</h2></td></tr>
 
64
<tr><td nowrap align=right valign=top>OggFLAC_API const char *const&nbsp;</td><td valign=bottom><a class="el" href="group__oggflac__stream__decoder.html#a0">OggFLAC__StreamDecoderStateString</a> []</td></tr>
 
65
</table>
 
66
<hr><a name="_details"></a><h2>Detailed Description</h2>
 
67
This module contains the functions which implement the stream decoder.
 
68
<p>
 
69
 
 
70
<p>
 
71
 The interface here is identical to FLAC's stream decoder, including the callbacks. See the <a class="el" href="group__flac__stream__decoder.html">FLAC stream decoder module</a> for full documentation. <hr><h2>Typedef Documentation</h2>
 
72
<a name="a1" doxytag="stream_decoder.h::OggFLAC__StreamDecoderReadCallback"></a><p>
 
73
<table width="100%" cellpadding="2" cellspacing="0" border="0">
 
74
  <tr>
 
75
    <td class="md">
 
76
      <table cellpadding="0" cellspacing="0" border="0">
 
77
        <tr>
 
78
          <td class="md" nowrap valign="top"> typedef <a class="el" href="group__flac__stream__decoder.html#a35">FLAC__StreamDecoderReadStatus</a>(* OggFLAC__StreamDecoderReadCallback)(const <a class="el" href="structOggFLAC____StreamDecoder.html">OggFLAC__StreamDecoder</a> *decoder, FLAC__byte buffer[], unsigned *bytes, void *client_data)
 
79
      </table>
 
80
    </td>
 
81
  </tr>
 
82
</table>
 
83
<table cellspacing=5 cellpadding=0 border=0>
 
84
  <tr>
 
85
    <td>
 
86
      &nbsp;
 
87
    </td>
 
88
    <td>
 
89
 
 
90
<p>
 
91
Signature for the read callback. See <a class="el" href="group__oggflac__stream__decoder.html#a7">OggFLAC__stream_decoder_set_read_callback</a>() and FLAC__StreamDecoderReadCallback for more info.<dl compact><dt><b>
 
92
Parameters: </b><dd>
 
93
<table border=0 cellspacing=2 cellpadding=0>
 
94
<tr><td valign=top><em>decoder</em>&nbsp;</td><td>
 
95
The decoder instance calling the callback. </td></tr>
 
96
<tr><td valign=top><em>buffer</em>&nbsp;</td><td>
 
97
A pointer to a location for the callee to store data to be decoded. </td></tr>
 
98
<tr><td valign=top><em>bytes</em>&nbsp;</td><td>
 
99
A pointer to the size of the buffer. </td></tr>
 
100
<tr><td valign=top><em>client_data</em>&nbsp;</td><td>
 
101
The callee's client data set through <a class="el" href="group__oggflac__stream__decoder.html#a11">OggFLAC__stream_decoder_set_client_data</a>(). </td></tr>
 
102
</table>
 
103
</dl><dl compact><dt><b>
 
104
Return values: </b><dd>
 
105
<table border=0 cellspacing=2 cellpadding=0>
 
106
<tr><td valign=top><em>FLAC__StreamDecoderReadStatus</em>&nbsp;</td><td>
 
107
The callee's return status. </td></tr>
 
108
</table>
 
109
</dl>    </td>
 
110
  </tr>
 
111
</table>
 
112
<a name="a2" doxytag="stream_decoder.h::OggFLAC__StreamDecoderWriteCallback"></a><p>
 
113
<table width="100%" cellpadding="2" cellspacing="0" border="0">
 
114
  <tr>
 
115
    <td class="md">
 
116
      <table cellpadding="0" cellspacing="0" border="0">
 
117
        <tr>
 
118
          <td class="md" nowrap valign="top"> typedef <a class="el" href="group__flac__stream__decoder.html#a36">FLAC__StreamDecoderWriteStatus</a>(* OggFLAC__StreamDecoderWriteCallback)(const <a class="el" href="structOggFLAC____StreamDecoder.html">OggFLAC__StreamDecoder</a> *decoder, const <a class="el" href="structFLAC____Frame.html">FLAC__Frame</a> *frame, const FLAC__int32 * const buffer[], void *client_data)
 
119
      </table>
 
120
    </td>
 
121
  </tr>
 
122
</table>
 
123
<table cellspacing=5 cellpadding=0 border=0>
 
124
  <tr>
 
125
    <td>
 
126
      &nbsp;
 
127
    </td>
 
128
    <td>
 
129
 
 
130
<p>
 
131
Signature for the write callback. See <a class="el" href="group__oggflac__stream__decoder.html#a8">OggFLAC__stream_decoder_set_write_callback</a>() and FLAC__StreamDecoderWriteCallback for more info.<dl compact><dt><b>
 
132
Parameters: </b><dd>
 
133
<table border=0 cellspacing=2 cellpadding=0>
 
134
<tr><td valign=top><em>decoder</em>&nbsp;</td><td>
 
135
The decoder instance calling the callback. </td></tr>
 
136
<tr><td valign=top><em>frame</em>&nbsp;</td><td>
 
137
The description of the decoded frame. </td></tr>
 
138
<tr><td valign=top><em>buffer</em>&nbsp;</td><td>
 
139
An array of pointers to decoded channels of data. </td></tr>
 
140
<tr><td valign=top><em>client_data</em>&nbsp;</td><td>
 
141
The callee's client data set through <a class="el" href="group__oggflac__stream__decoder.html#a11">OggFLAC__stream_decoder_set_client_data</a>(). </td></tr>
 
142
</table>
 
143
</dl><dl compact><dt><b>
 
144
Return values: </b><dd>
 
145
<table border=0 cellspacing=2 cellpadding=0>
 
146
<tr><td valign=top><em>FLAC__StreamDecoderWriteStatus</em>&nbsp;</td><td>
 
147
The callee's return status. </td></tr>
 
148
</table>
 
149
</dl>    </td>
 
150
  </tr>
 
151
</table>
 
152
<a name="a3" doxytag="stream_decoder.h::OggFLAC__StreamDecoderMetadataCallback"></a><p>
 
153
<table width="100%" cellpadding="2" cellspacing="0" border="0">
 
154
  <tr>
 
155
    <td class="md">
 
156
      <table cellpadding="0" cellspacing="0" border="0">
 
157
        <tr>
 
158
          <td class="md" nowrap valign="top"> typedef void(* OggFLAC__StreamDecoderMetadataCallback)(const <a class="el" href="structOggFLAC____StreamDecoder.html">OggFLAC__StreamDecoder</a> *decoder, const <a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> *metadata, void *client_data)
 
159
      </table>
 
160
    </td>
 
161
  </tr>
 
162
</table>
 
163
<table cellspacing=5 cellpadding=0 border=0>
 
164
  <tr>
 
165
    <td>
 
166
      &nbsp;
 
167
    </td>
 
168
    <td>
 
169
 
 
170
<p>
 
171
Signature for the metadata callback. See <a class="el" href="group__oggflac__stream__decoder.html#a9">OggFLAC__stream_decoder_set_metadata_callback</a>() and FLAC__StreamDecoderMetadataCallback for more info.<dl compact><dt><b>
 
172
Parameters: </b><dd>
 
173
<table border=0 cellspacing=2 cellpadding=0>
 
174
<tr><td valign=top><em>decoder</em>&nbsp;</td><td>
 
175
The decoder instance calling the callback. </td></tr>
 
176
<tr><td valign=top><em>metadata</em>&nbsp;</td><td>
 
177
The decoded metadata block. </td></tr>
 
178
<tr><td valign=top><em>client_data</em>&nbsp;</td><td>
 
179
The callee's client data set through <a class="el" href="group__oggflac__stream__decoder.html#a11">OggFLAC__stream_decoder_set_client_data</a>(). </td></tr>
 
180
</table>
 
181
</dl>    </td>
 
182
  </tr>
 
183
</table>
 
184
<a name="a4" doxytag="stream_decoder.h::OggFLAC__StreamDecoderErrorCallback"></a><p>
 
185
<table width="100%" cellpadding="2" cellspacing="0" border="0">
 
186
  <tr>
 
187
    <td class="md">
 
188
      <table cellpadding="0" cellspacing="0" border="0">
 
189
        <tr>
 
190
          <td class="md" nowrap valign="top"> typedef void(* OggFLAC__StreamDecoderErrorCallback)(const <a class="el" href="structOggFLAC____StreamDecoder.html">OggFLAC__StreamDecoder</a> *decoder, <a class="el" href="group__flac__stream__decoder.html#a37">FLAC__StreamDecoderErrorStatus</a> status, void *client_data)
 
191
      </table>
 
192
    </td>
 
193
  </tr>
 
194
</table>
 
195
<table cellspacing=5 cellpadding=0 border=0>
 
196
  <tr>
 
197
    <td>
 
198
      &nbsp;
 
199
    </td>
 
200
    <td>
 
201
 
 
202
<p>
 
203
Signature for the error callback. See <a class="el" href="group__oggflac__stream__decoder.html#a10">OggFLAC__stream_decoder_set_error_callback</a>() and FLAC__StreamDecoderErrorCallback for more info.<dl compact><dt><b>
 
204
Parameters: </b><dd>
 
205
<table border=0 cellspacing=2 cellpadding=0>
 
206
<tr><td valign=top><em>decoder</em>&nbsp;</td><td>
 
207
The decoder instance calling the callback. </td></tr>
 
208
<tr><td valign=top><em>status</em>&nbsp;</td><td>
 
209
The error encountered by the decoder. </td></tr>
 
210
<tr><td valign=top><em>client_data</em>&nbsp;</td><td>
 
211
The callee's client data set through <a class="el" href="group__oggflac__stream__decoder.html#a11">OggFLAC__stream_decoder_set_client_data</a>(). </td></tr>
 
212
</table>
 
213
</dl>    </td>
 
214
  </tr>
 
215
</table>
 
216
<hr><h2>Enumeration Type Documentation</h2>
 
217
<a name="a33" doxytag="stream_decoder.h::OggFLAC__StreamDecoderState"></a><p>
 
218
<table width="100%" cellpadding="2" cellspacing="0" border="0">
 
219
  <tr>
 
220
    <td class="md">
 
221
      <table cellpadding="0" cellspacing="0" border="0">
 
222
        <tr>
 
223
          <td class="md" nowrap valign="top"> enum OggFLAC__StreamDecoderState
 
224
      </table>
 
225
    </td>
 
226
  </tr>
 
227
</table>
 
228
<table cellspacing=5 cellpadding=0 border=0>
 
229
  <tr>
 
230
    <td>
 
231
      &nbsp;
 
232
    </td>
 
233
    <td>
 
234
 
 
235
<p>
 
236
State values for an <a class="el" href="structOggFLAC____StreamDecoder.html">OggFLAC__StreamDecoder</a>
 
237
<p>
 
238
The decoder's state can be obtained by calling <a class="el" href="group__oggflac__stream__decoder.html#a19">OggFLAC__stream_decoder_get_state</a>(). <dl compact><dt><b>
 
239
Enumeration values:</b><dd>
 
240
<table border=0 cellspacing=2 cellpadding=0>
 
241
<tr><td valign=top><em><a name="a33a5" doxytag="OggFLAC__STREAM_DECODER_OK"></a><em>OggFLAC__STREAM_DECODER_OK</em></em>&nbsp;</td><td>
 
242
The decoder is in the normal OK state. </td></tr>
 
243
<tr><td valign=top><em><a name="a33a6" doxytag="OggFLAC__STREAM_DECODER_OGG_ERROR"></a><em>OggFLAC__STREAM_DECODER_OGG_ERROR</em></em>&nbsp;</td><td>
 
244
An error occurred in the underlying Ogg layer. </td></tr>
 
245
<tr><td valign=top><em><a name="a33a7" doxytag="OggFLAC__STREAM_DECODER_READ_ERROR"></a><em>OggFLAC__STREAM_DECODER_READ_ERROR</em></em>&nbsp;</td><td>
 
246
The read callback returned an error. </td></tr>
 
247
<tr><td valign=top><em><a name="a33a8" doxytag="OggFLAC__STREAM_DECODER_FLAC_STREAM_DECODER_ERROR"></a><em>OggFLAC__STREAM_DECODER_FLAC_STREAM_DECODER_ERROR</em></em>&nbsp;</td><td>
 
248
An error occurred in the underlying FLAC stream decoder; check <a class="el" href="group__oggflac__stream__decoder.html#a20">OggFLAC__stream_decoder_get_FLAC_stream_decoder_state</a>(). </td></tr>
 
249
<tr><td valign=top><em><a name="a33a9" doxytag="OggFLAC__STREAM_DECODER_INVALID_CALLBACK"></a><em>OggFLAC__STREAM_DECODER_INVALID_CALLBACK</em></em>&nbsp;</td><td>
 
250
The decoder was initialized before setting all the required callbacks. </td></tr>
 
251
<tr><td valign=top><em><a name="a33a10" doxytag="OggFLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR"></a><em>OggFLAC__STREAM_DECODER_MEMORY_ALLOCATION_ERROR</em></em>&nbsp;</td><td>
 
252
Memory allocation failed. </td></tr>
 
253
<tr><td valign=top><em><a name="a33a11" doxytag="OggFLAC__STREAM_DECODER_ALREADY_INITIALIZED"></a><em>OggFLAC__STREAM_DECODER_ALREADY_INITIALIZED</em></em>&nbsp;</td><td>
 
254
<a class="el" href="group__oggflac__stream__decoder.html#a26">OggFLAC__stream_decoder_init</a>() was called when the decoder was already initialized, usually because <a class="el" href="group__oggflac__stream__decoder.html#a27">OggFLAC__stream_decoder_finish</a>() was not called. </td></tr>
 
255
<tr><td valign=top><em><a name="a33a12" doxytag="OggFLAC__STREAM_DECODER_UNINITIALIZED"></a><em>OggFLAC__STREAM_DECODER_UNINITIALIZED</em></em>&nbsp;</td><td>
 
256
The decoder is in the uninitialized state. </td></tr>
 
257
</table>
 
258
</dl>
 
259
    </td>
 
260
  </tr>
 
261
</table>
 
262
<hr><h2>Function Documentation</h2>
 
263
<a name="a5" doxytag="stream_decoder.h::OggFLAC__stream_decoder_new"></a><p>
 
264
<table width="100%" cellpadding="2" cellspacing="0" border="0">
 
265
  <tr>
 
266
    <td class="md">
 
267
      <table cellpadding="0" cellspacing="0" border="0">
 
268
        <tr>
 
269
          <td class="md" nowrap valign="top"> OggFLAC_API <a class="el" href="structOggFLAC____StreamDecoder.html">OggFLAC__StreamDecoder</a>* OggFLAC__stream_decoder_new </td>
 
270
          <td class="md" valign="top">(&nbsp;</td>
 
271
          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
 
272
          <td class="md" valign="top">)&nbsp;</td>
 
273
          <td class="md" nowrap></td>
 
274
        </tr>
 
275
 
 
276
      </table>
 
277
    </td>
 
278
  </tr>
 
279
</table>
 
280
<table cellspacing=5 cellpadding=0 border=0>
 
281
  <tr>
 
282
    <td>
 
283
      &nbsp;
 
284
    </td>
 
285
    <td>
 
286
 
 
287
<p>
 
288
Create a new stream decoder instance. The instance is created with default settings; see the individual OggFLAC__stream_decoder_set_*() functions for each setting's default.<dl compact><dt><b>
 
289
Return values: </b><dd>
 
290
<table border=0 cellspacing=2 cellpadding=0>
 
291
<tr><td valign=top><em><a class="el" href="structOggFLAC____StreamDecoder.html">OggFLAC__StreamDecoder</a></em>&nbsp;</td><td>
 
292
* <code>NULL</code> if there was an error allocating memory, else the new instance. </td></tr>
 
293
</table>
 
294
</dl>    </td>
 
295
  </tr>
 
296
</table>
 
297
<a name="a6" doxytag="stream_decoder.h::OggFLAC__stream_decoder_delete"></a><p>
 
298
<table width="100%" cellpadding="2" cellspacing="0" border="0">
 
299
  <tr>
 
300
    <td class="md">
 
301
      <table cellpadding="0" cellspacing="0" border="0">
 
302
        <tr>
 
303
          <td class="md" nowrap valign="top"> OggFLAC_API void OggFLAC__stream_decoder_delete </td>
 
304
          <td class="md" valign="top">(&nbsp;</td>
 
305
          <td class="md" nowrap valign="top"><a class="el" href="structOggFLAC____StreamDecoder.html">OggFLAC__StreamDecoder</a> *&nbsp;</td>
 
306
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>decoder</em>          </td>
 
307
          <td class="md" valign="top">)&nbsp;</td>
 
308
          <td class="md" nowrap></td>
 
309
        </tr>
 
310
 
 
311
      </table>
 
312
    </td>
 
313
  </tr>
 
314
</table>
 
315
<table cellspacing=5 cellpadding=0 border=0>
 
316
  <tr>
 
317
    <td>
 
318
      &nbsp;
 
319
    </td>
 
320
    <td>
 
321
 
 
322
<p>
 
323
Free a decoder instance. Deletes the object pointed to by <em>decoder</em>.<dl compact><dt><b>
 
324
Parameters: </b><dd>
 
325
<table border=0 cellspacing=2 cellpadding=0>
 
326
<tr><td valign=top><em>decoder</em>&nbsp;</td><td>
 
327
A pointer to an existing decoder. </td></tr>
 
328
</table>
 
329
</dl><dl compact><dt><b>
 
330
Assertions:</b><dd>
 
331
 <div class="fragment"><pre>decoder != NULL 
 
332
</pre></div> </dl>    </td>
 
333
  </tr>
 
334
</table>
 
335
<a name="a7" doxytag="stream_decoder.h::OggFLAC__stream_decoder_set_read_callback"></a><p>
 
336
<table width="100%" cellpadding="2" cellspacing="0" border="0">
 
337
  <tr>
 
338
    <td class="md">
 
339
      <table cellpadding="0" cellspacing="0" border="0">
 
340
        <tr>
 
341
          <td class="md" nowrap valign="top"> OggFLAC_API FLAC__bool OggFLAC__stream_decoder_set_read_callback </td>
 
342
          <td class="md" valign="top">(&nbsp;</td>
 
343
          <td class="md" nowrap valign="top"><a class="el" href="structOggFLAC____StreamDecoder.html">OggFLAC__StreamDecoder</a> *&nbsp;</td>
 
344
          <td class="mdname" nowrap>&nbsp; <em>decoder</em>, </td>
 
345
        </tr>
 
346
        <tr>
 
347
          <td></td>
 
348
          <td></td>
 
349
          <td class="md" nowrap><a class="el" href="group__oggflac__stream__decoder.html#a1">OggFLAC__StreamDecoderReadCallback</a>&nbsp;</td>
 
350
          <td class="mdname" nowrap>&nbsp; <em>value</em></td>
 
351
        </tr>
 
352
        <tr>
 
353
          <td></td>
 
354
          <td class="md">)&nbsp;</td>
 
355
          <td class="md" colspan="2"></td>
 
356
        </tr>
 
357
 
 
358
      </table>
 
359
    </td>
 
360
  </tr>
 
361
</table>
 
362
<table cellspacing=5 cellpadding=0 border=0>
 
363
  <tr>
 
364
    <td>
 
365
      &nbsp;
 
366
    </td>
 
367
    <td>
 
368
 
 
369
<p>
 
370
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>()
 
371
<p>
 
372
<dl compact><dt><b>
 
373
Note: </b><dd>
 
374
 The callback is mandatory and must be set before initialization.</dl><dl compact><dt><b>
 
375
Default Value:</b><dd>
 
376
 <code>NULL</code> </dl><dl compact><dt><b>
 
377
Parameters: </b><dd>
 
378
<table border=0 cellspacing=2 cellpadding=0>
 
379
<tr><td valign=top><em>decoder</em>&nbsp;</td><td>
 
380
A decoder instance to set. </td></tr>
 
381
<tr><td valign=top><em>value</em>&nbsp;</td><td>
 
382
See above. </td></tr>
 
383
</table>
 
384
</dl><dl compact><dt><b>
 
385
Assertions:</b><dd>
 
386
 <div class="fragment"><pre>decoder != NULL 
 
387
</pre></div> <div class="fragment"><pre>value != NULL 
 
388
</pre></div> </dl><dl compact><dt><b>
 
389
Return values: </b><dd>
 
390
<table border=0 cellspacing=2 cellpadding=0>
 
391
<tr><td valign=top><em>FLAC__bool</em>&nbsp;</td><td>
 
392
<code>false</code> if the decoder is already initialized, else <code>true</code>. </td></tr>
 
393
</table>
 
394
</dl>    </td>
 
395
  </tr>
 
396
</table>
 
397
<a name="a8" doxytag="stream_decoder.h::OggFLAC__stream_decoder_set_write_callback"></a><p>
 
398
<table width="100%" cellpadding="2" cellspacing="0" border="0">
 
399
  <tr>
 
400
    <td class="md">
 
401
      <table cellpadding="0" cellspacing="0" border="0">
 
402
        <tr>
 
403
          <td class="md" nowrap valign="top"> OggFLAC_API FLAC__bool OggFLAC__stream_decoder_set_write_callback </td>
 
404
          <td class="md" valign="top">(&nbsp;</td>
 
405
          <td class="md" nowrap valign="top"><a class="el" href="structOggFLAC____StreamDecoder.html">OggFLAC__StreamDecoder</a> *&nbsp;</td>
 
406
          <td class="mdname" nowrap>&nbsp; <em>decoder</em>, </td>
 
407
        </tr>
 
408
        <tr>
 
409
          <td></td>
 
410
          <td></td>
 
411
          <td class="md" nowrap><a class="el" href="group__oggflac__stream__decoder.html#a2">OggFLAC__StreamDecoderWriteCallback</a>&nbsp;</td>
 
412
          <td class="mdname" nowrap>&nbsp; <em>value</em></td>
 
413
        </tr>
 
414
        <tr>
 
415
          <td></td>
 
416
          <td class="md">)&nbsp;</td>
 
417
          <td class="md" colspan="2"></td>
 
418
        </tr>
 
419
 
 
420
      </table>
 
421
    </td>
 
422
  </tr>
 
423
</table>
 
424
<table cellspacing=5 cellpadding=0 border=0>
 
425
  <tr>
 
426
    <td>
 
427
      &nbsp;
 
428
    </td>
 
429
    <td>
 
430
 
 
431
<p>
 
432
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>()
 
433
<p>
 
434
<dl compact><dt><b>
 
435
Note: </b><dd>
 
436
 The callback is mandatory and must be set before initialization.</dl><dl compact><dt><b>
 
437
Default Value:</b><dd>
 
438
 <code>NULL</code> </dl><dl compact><dt><b>
 
439
Parameters: </b><dd>
 
440
<table border=0 cellspacing=2 cellpadding=0>
 
441
<tr><td valign=top><em>decoder</em>&nbsp;</td><td>
 
442
A decoder instance to set. </td></tr>
 
443
<tr><td valign=top><em>value</em>&nbsp;</td><td>
 
444
See above. </td></tr>
 
445
</table>
 
446
</dl><dl compact><dt><b>
 
447
Assertions:</b><dd>
 
448
 <div class="fragment"><pre>decoder != NULL 
 
449
</pre></div> <div class="fragment"><pre>value != NULL 
 
450
</pre></div> </dl><dl compact><dt><b>
 
451
Return values: </b><dd>
 
452
<table border=0 cellspacing=2 cellpadding=0>
 
453
<tr><td valign=top><em>FLAC__bool</em>&nbsp;</td><td>
 
454
<code>false</code> if the decoder is already initialized, else <code>true</code>. </td></tr>
 
455
</table>
 
456
</dl>    </td>
 
457
  </tr>
 
458
</table>
 
459
<a name="a9" doxytag="stream_decoder.h::OggFLAC__stream_decoder_set_metadata_callback"></a><p>
 
460
<table width="100%" cellpadding="2" cellspacing="0" border="0">
 
461
  <tr>
 
462
    <td class="md">
 
463
      <table cellpadding="0" cellspacing="0" border="0">
 
464
        <tr>
 
465
          <td class="md" nowrap valign="top"> OggFLAC_API FLAC__bool OggFLAC__stream_decoder_set_metadata_callback </td>
 
466
          <td class="md" valign="top">(&nbsp;</td>
 
467
          <td class="md" nowrap valign="top"><a class="el" href="structOggFLAC____StreamDecoder.html">OggFLAC__StreamDecoder</a> *&nbsp;</td>
 
468
          <td class="mdname" nowrap>&nbsp; <em>decoder</em>, </td>
 
469
        </tr>
 
470
        <tr>
 
471
          <td></td>
 
472
          <td></td>
 
473
          <td class="md" nowrap><a class="el" href="group__oggflac__stream__decoder.html#a3">OggFLAC__StreamDecoderMetadataCallback</a>&nbsp;</td>
 
474
          <td class="mdname" nowrap>&nbsp; <em>value</em></td>
 
475
        </tr>
 
476
        <tr>
 
477
          <td></td>
 
478
          <td class="md">)&nbsp;</td>
 
479
          <td class="md" colspan="2"></td>
 
480
        </tr>
 
481
 
 
482
      </table>
 
483
    </td>
 
484
  </tr>
 
485
</table>
 
486
<table cellspacing=5 cellpadding=0 border=0>
 
487
  <tr>
 
488
    <td>
 
489
      &nbsp;
 
490
    </td>
 
491
    <td>
 
492
 
 
493
<p>
 
494
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>()
 
495
<p>
 
496
<dl compact><dt><b>
 
497
Note: </b><dd>
 
498
 The callback is mandatory and must be set before initialization.</dl><dl compact><dt><b>
 
499
Default Value:</b><dd>
 
500
 <code>NULL</code> </dl><dl compact><dt><b>
 
501
Parameters: </b><dd>
 
502
<table border=0 cellspacing=2 cellpadding=0>
 
503
<tr><td valign=top><em>decoder</em>&nbsp;</td><td>
 
504
A decoder instance to set. </td></tr>
 
505
<tr><td valign=top><em>value</em>&nbsp;</td><td>
 
506
See above. </td></tr>
 
507
</table>
 
508
</dl><dl compact><dt><b>
 
509
Assertions:</b><dd>
 
510
 <div class="fragment"><pre>decoder != NULL 
 
511
</pre></div> <div class="fragment"><pre>value != NULL 
 
512
</pre></div> </dl><dl compact><dt><b>
 
513
Return values: </b><dd>
 
514
<table border=0 cellspacing=2 cellpadding=0>
 
515
<tr><td valign=top><em>FLAC__bool</em>&nbsp;</td><td>
 
516
<code>false</code> if the decoder is already initialized, else <code>true</code>. </td></tr>
 
517
</table>
 
518
</dl>    </td>
 
519
  </tr>
 
520
</table>
 
521
<a name="a10" doxytag="stream_decoder.h::OggFLAC__stream_decoder_set_error_callback"></a><p>
 
522
<table width="100%" cellpadding="2" cellspacing="0" border="0">
 
523
  <tr>
 
524
    <td class="md">
 
525
      <table cellpadding="0" cellspacing="0" border="0">
 
526
        <tr>
 
527
          <td class="md" nowrap valign="top"> OggFLAC_API FLAC__bool OggFLAC__stream_decoder_set_error_callback </td>
 
528
          <td class="md" valign="top">(&nbsp;</td>
 
529
          <td class="md" nowrap valign="top"><a class="el" href="structOggFLAC____StreamDecoder.html">OggFLAC__StreamDecoder</a> *&nbsp;</td>
 
530
          <td class="mdname" nowrap>&nbsp; <em>decoder</em>, </td>
 
531
        </tr>
 
532
        <tr>
 
533
          <td></td>
 
534
          <td></td>
 
535
          <td class="md" nowrap><a class="el" href="group__oggflac__stream__decoder.html#a4">OggFLAC__StreamDecoderErrorCallback</a>&nbsp;</td>
 
536
          <td class="mdname" nowrap>&nbsp; <em>value</em></td>
 
537
        </tr>
 
538
        <tr>
 
539
          <td></td>
 
540
          <td class="md">)&nbsp;</td>
 
541
          <td class="md" colspan="2"></td>
 
542
        </tr>
 
543
 
 
544
      </table>
 
545
    </td>
 
546
  </tr>
 
547
</table>
 
548
<table cellspacing=5 cellpadding=0 border=0>
 
549
  <tr>
 
550
    <td>
 
551
      &nbsp;
 
552
    </td>
 
553
    <td>
 
554
 
 
555
<p>
 
556
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>()
 
557
<p>
 
558
<dl compact><dt><b>
 
559
Note: </b><dd>
 
560
 The callback is mandatory and must be set before initialization.</dl><dl compact><dt><b>
 
561
Default Value:</b><dd>
 
562
 <code>NULL</code> </dl><dl compact><dt><b>
 
563
Parameters: </b><dd>
 
564
<table border=0 cellspacing=2 cellpadding=0>
 
565
<tr><td valign=top><em>decoder</em>&nbsp;</td><td>
 
566
A decoder instance to set. </td></tr>
 
567
<tr><td valign=top><em>value</em>&nbsp;</td><td>
 
568
See above. </td></tr>
 
569
</table>
 
570
</dl><dl compact><dt><b>
 
571
Assertions:</b><dd>
 
572
 <div class="fragment"><pre>decoder != NULL 
 
573
</pre></div> <div class="fragment"><pre>value != NULL 
 
574
</pre></div> </dl><dl compact><dt><b>
 
575
Return values: </b><dd>
 
576
<table border=0 cellspacing=2 cellpadding=0>
 
577
<tr><td valign=top><em>FLAC__bool</em>&nbsp;</td><td>
 
578
<code>false</code> if the decoder is already initialized, else <code>true</code>. </td></tr>
 
579
</table>
 
580
</dl>    </td>
 
581
  </tr>
 
582
</table>
 
583
<a name="a11" doxytag="stream_decoder.h::OggFLAC__stream_decoder_set_client_data"></a><p>
 
584
<table width="100%" cellpadding="2" cellspacing="0" border="0">
 
585
  <tr>
 
586
    <td class="md">
 
587
      <table cellpadding="0" cellspacing="0" border="0">
 
588
        <tr>
 
589
          <td class="md" nowrap valign="top"> OggFLAC_API FLAC__bool OggFLAC__stream_decoder_set_client_data </td>
 
590
          <td class="md" valign="top">(&nbsp;</td>
 
591
          <td class="md" nowrap valign="top"><a class="el" href="structOggFLAC____StreamDecoder.html">OggFLAC__StreamDecoder</a> *&nbsp;</td>
 
592
          <td class="mdname" nowrap>&nbsp; <em>decoder</em>, </td>
 
593
        </tr>
 
594
        <tr>
 
595
          <td></td>
 
596
          <td></td>
 
597
          <td class="md" nowrap>void *&nbsp;</td>
 
598
          <td class="mdname" nowrap>&nbsp; <em>value</em></td>
 
599
        </tr>
 
600
        <tr>
 
601
          <td></td>
 
602
          <td class="md">)&nbsp;</td>
 
603
          <td class="md" colspan="2"></td>
 
604
        </tr>
 
605
 
 
606
      </table>
 
607
    </td>
 
608
  </tr>
 
609
</table>
 
610
<table cellspacing=5 cellpadding=0 border=0>
 
611
  <tr>
 
612
    <td>
 
613
      &nbsp;
 
614
    </td>
 
615
    <td>
 
616
 
 
617
<p>
 
618
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>
 
619
Default Value:</b><dd>
 
620
 <code>NULL</code> </dl><dl compact><dt><b>
 
621
Parameters: </b><dd>
 
622
<table border=0 cellspacing=2 cellpadding=0>
 
623
<tr><td valign=top><em>decoder</em>&nbsp;</td><td>
 
624
A decoder instance to set. </td></tr>
 
625
<tr><td valign=top><em>value</em>&nbsp;</td><td>
 
626
See above. </td></tr>
 
627
</table>
 
628
</dl><dl compact><dt><b>
 
629
Assertions:</b><dd>
 
630
 <div class="fragment"><pre>decoder != NULL 
 
631
</pre></div> </dl><dl compact><dt><b>
 
632
Return values: </b><dd>
 
633
<table border=0 cellspacing=2 cellpadding=0>
 
634
<tr><td valign=top><em>FLAC__bool</em>&nbsp;</td><td>
 
635
<code>false</code> if the decoder is already initialized, else <code>true</code>. </td></tr>
 
636
</table>
 
637
</dl>    </td>
 
638
  </tr>
 
639
</table>
 
640
<a name="a12" doxytag="stream_decoder.h::OggFLAC__stream_decoder_set_serial_number"></a><p>
 
641
<table width="100%" cellpadding="2" cellspacing="0" border="0">
 
642
  <tr>
 
643
    <td class="md">
 
644
      <table cellpadding="0" cellspacing="0" border="0">
 
645
        <tr>
 
646
          <td class="md" nowrap valign="top"> OggFLAC_API FLAC__bool OggFLAC__stream_decoder_set_serial_number </td>
 
647
          <td class="md" valign="top">(&nbsp;</td>
 
648
          <td class="md" nowrap valign="top"><a class="el" href="structOggFLAC____StreamDecoder.html">OggFLAC__StreamDecoder</a> *&nbsp;</td>
 
649
          <td class="mdname" nowrap>&nbsp; <em>decoder</em>, </td>
 
650
        </tr>
 
651
        <tr>
 
652
          <td></td>
 
653
          <td></td>
 
654
          <td class="md" nowrap>long&nbsp;</td>
 
655
          <td class="mdname" nowrap>&nbsp; <em>serial_number</em></td>
 
656
        </tr>
 
657
        <tr>
 
658
          <td></td>
 
659
          <td class="md">)&nbsp;</td>
 
660
          <td class="md" colspan="2"></td>
 
661
        </tr>
 
662
 
 
663
      </table>
 
664
    </td>
 
665
  </tr>
 
666
</table>
 
667
<table cellspacing=5 cellpadding=0 border=0>
 
668
  <tr>
 
669
    <td>
 
670
      &nbsp;
 
671
    </td>
 
672
    <td>
 
673
 
 
674
<p>
 
675
Set the serial number for the Ogg stream. The default behavior is to use the serial number of the first Ogg page. Setting a serial number here will explicitly define which stream is to be decoded.<dl compact><dt><b>
 
676
Default Value:</b><dd>
 
677
 <code>use</code> serial number of first page </dl><dl compact><dt><b>
 
678
Parameters: </b><dd>
 
679
<table border=0 cellspacing=2 cellpadding=0>
 
680
<tr><td valign=top><em>decoder</em>&nbsp;</td><td>
 
681
A decoder instance to set. </td></tr>
 
682
<tr><td valign=top><em>serial_number</em>&nbsp;</td><td>
 
683
See above. </td></tr>
 
684
</table>
 
685
</dl><dl compact><dt><b>
 
686
Assertions:</b><dd>
 
687
 <div class="fragment"><pre>decoder != NULL 
 
688
</pre></div> </dl><dl compact><dt><b>
 
689
Return values: </b><dd>
 
690
<table border=0 cellspacing=2 cellpadding=0>
 
691
<tr><td valign=top><em>FLAC__bool</em>&nbsp;</td><td>
 
692
<code>false</code> if the decoder is already initialized, else <code>true</code>. </td></tr>
 
693
</table>
 
694
</dl>    </td>
 
695
  </tr>
 
696
</table>
 
697
<a name="a13" doxytag="stream_decoder.h::OggFLAC__stream_decoder_set_metadata_respond"></a><p>
 
698
<table width="100%" cellpadding="2" cellspacing="0" border="0">
 
699
  <tr>
 
700
    <td class="md">
 
701
      <table cellpadding="0" cellspacing="0" border="0">
 
702
        <tr>
 
703
          <td class="md" nowrap valign="top"> OggFLAC_API FLAC__bool OggFLAC__stream_decoder_set_metadata_respond </td>
 
704
          <td class="md" valign="top">(&nbsp;</td>
 
705
          <td class="md" nowrap valign="top"><a class="el" href="structOggFLAC____StreamDecoder.html">OggFLAC__StreamDecoder</a> *&nbsp;</td>
 
706
          <td class="mdname" nowrap>&nbsp; <em>decoder</em>, </td>
 
707
        </tr>
 
708
        <tr>
 
709
          <td></td>
 
710
          <td></td>
 
711
          <td class="md" nowrap><a class="el" href="group__flac__format.html#a93">FLAC__MetadataType</a>&nbsp;</td>
 
712
          <td class="mdname" nowrap>&nbsp; <em>type</em></td>
 
713
        </tr>
 
714
        <tr>
 
715
          <td></td>
 
716
          <td class="md">)&nbsp;</td>
 
717
          <td class="md" colspan="2"></td>
 
718
        </tr>
 
719
 
 
720
      </table>
 
721
    </td>
 
722
  </tr>
 
723
</table>
 
724
<table cellspacing=5 cellpadding=0 border=0>
 
725
  <tr>
 
726
    <td>
 
727
      &nbsp;
 
728
    </td>
 
729
    <td>
 
730
 
 
731
<p>
 
732
Direct the decoder to pass on all metadata blocks of type <em>type</em>. 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>
 
733
Default Value:</b><dd>
 
734
 By default, only the <code>STREAMINFO</code> block is returned via the metadata callback. </dl><dl compact><dt><b>
 
735
Parameters: </b><dd>
 
736
<table border=0 cellspacing=2 cellpadding=0>
 
737
<tr><td valign=top><em>decoder</em>&nbsp;</td><td>
 
738
A decoder instance to set. </td></tr>
 
739
<tr><td valign=top><em>type</em>&nbsp;</td><td>
 
740
See above. </td></tr>
 
741
</table>
 
742
</dl><dl compact><dt><b>
 
743
Assertions:</b><dd>
 
744
 <div class="fragment"><pre>decoder != NULL 
 
745
</pre></div> <em>type</em> is valid </dl><dl compact><dt><b>
 
746
Return values: </b><dd>
 
747
<table border=0 cellspacing=2 cellpadding=0>
 
748
<tr><td valign=top><em>FLAC__bool</em>&nbsp;</td><td>
 
749
<code>false</code> if the decoder is already initialized, else <code>true</code>. </td></tr>
 
750
</table>
 
751
</dl>    </td>
 
752
  </tr>
 
753
</table>
 
754
<a name="a14" doxytag="stream_decoder.h::OggFLAC__stream_decoder_set_metadata_respond_application"></a><p>
 
755
<table width="100%" cellpadding="2" cellspacing="0" border="0">
 
756
  <tr>
 
757
    <td class="md">
 
758
      <table cellpadding="0" cellspacing="0" border="0">
 
759
        <tr>
 
760
          <td class="md" nowrap valign="top"> OggFLAC_API FLAC__bool OggFLAC__stream_decoder_set_metadata_respond_application </td>
 
761
          <td class="md" valign="top">(&nbsp;</td>
 
762
          <td class="md" nowrap valign="top"><a class="el" href="structOggFLAC____StreamDecoder.html">OggFLAC__StreamDecoder</a> *&nbsp;</td>
 
763
          <td class="mdname" nowrap>&nbsp; <em>decoder</em>, </td>
 
764
        </tr>
 
765
        <tr>
 
766
          <td></td>
 
767
          <td></td>
 
768
          <td class="md" nowrap>const FLAC__byte&nbsp;</td>
 
769
          <td class="mdname" nowrap>&nbsp; <em>id</em>[4]</td>
 
770
        </tr>
 
771
        <tr>
 
772
          <td></td>
 
773
          <td class="md">)&nbsp;</td>
 
774
          <td class="md" colspan="2"></td>
 
775
        </tr>
 
776
 
 
777
      </table>
 
778
    </td>
 
779
  </tr>
 
780
</table>
 
781
<table cellspacing=5 cellpadding=0 border=0>
 
782
  <tr>
 
783
    <td>
 
784
      &nbsp;
 
785
    </td>
 
786
    <td>
 
787
 
 
788
<p>
 
789
Direct the decoder to pass on all APPLICATION metadata blocks of the given <em>id</em>. 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>
 
790
Default Value:</b><dd>
 
791
 By default, only the <code>STREAMINFO</code> block is returned via the metadata callback. </dl><dl compact><dt><b>
 
792
Parameters: </b><dd>
 
793
<table border=0 cellspacing=2 cellpadding=0>
 
794
<tr><td valign=top><em>decoder</em>&nbsp;</td><td>
 
795
A decoder instance to set. </td></tr>
 
796
<tr><td valign=top><em>id</em>&nbsp;</td><td>
 
797
See above. </td></tr>
 
798
</table>
 
799
</dl><dl compact><dt><b>
 
800
Assertions:</b><dd>
 
801
 <div class="fragment"><pre>decoder != NULL 
 
802
</pre></div> <div class="fragment"><pre>id != NULL 
 
803
</pre></div> </dl><dl compact><dt><b>
 
804
Return values: </b><dd>
 
805
<table border=0 cellspacing=2 cellpadding=0>
 
806
<tr><td valign=top><em>FLAC__bool</em>&nbsp;</td><td>
 
807
<code>false</code> if the decoder is already initialized, else <code>true</code>. </td></tr>
 
808
</table>
 
809
</dl>    </td>
 
810
  </tr>
 
811
</table>
 
812
<a name="a15" doxytag="stream_decoder.h::OggFLAC__stream_decoder_set_metadata_respond_all"></a><p>
 
813
<table width="100%" cellpadding="2" cellspacing="0" border="0">
 
814
  <tr>
 
815
    <td class="md">
 
816
      <table cellpadding="0" cellspacing="0" border="0">
 
817
        <tr>
 
818
          <td class="md" nowrap valign="top"> OggFLAC_API FLAC__bool OggFLAC__stream_decoder_set_metadata_respond_all </td>
 
819
          <td class="md" valign="top">(&nbsp;</td>
 
820
          <td class="md" nowrap valign="top"><a class="el" href="structOggFLAC____StreamDecoder.html">OggFLAC__StreamDecoder</a> *&nbsp;</td>
 
821
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>decoder</em>          </td>
 
822
          <td class="md" valign="top">)&nbsp;</td>
 
823
          <td class="md" nowrap></td>
 
824
        </tr>
 
825
 
 
826
      </table>
 
827
    </td>
 
828
  </tr>
 
829
</table>
 
830
<table cellspacing=5 cellpadding=0 border=0>
 
831
  <tr>
 
832
    <td>
 
833
      &nbsp;
 
834
    </td>
 
835
    <td>
 
836
 
 
837
<p>
 
838
Direct the decoder to pass on all metadata blocks of any type. 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>
 
839
Default Value:</b><dd>
 
840
 By default, only the <code>STREAMINFO</code> block is returned via the metadata callback. </dl><dl compact><dt><b>
 
841
Parameters: </b><dd>
 
842
<table border=0 cellspacing=2 cellpadding=0>
 
843
<tr><td valign=top><em>decoder</em>&nbsp;</td><td>
 
844
A decoder instance to set. </td></tr>
 
845
</table>
 
846
</dl><dl compact><dt><b>
 
847
Assertions:</b><dd>
 
848
 <div class="fragment"><pre>decoder != NULL 
 
849
</pre></div> </dl><dl compact><dt><b>
 
850
Return values: </b><dd>
 
851
<table border=0 cellspacing=2 cellpadding=0>
 
852
<tr><td valign=top><em>FLAC__bool</em>&nbsp;</td><td>
 
853
<code>false</code> if the decoder is already initialized, else <code>true</code>. </td></tr>
 
854
</table>
 
855
</dl>    </td>
 
856
  </tr>
 
857
</table>
 
858
<a name="a16" doxytag="stream_decoder.h::OggFLAC__stream_decoder_set_metadata_ignore"></a><p>
 
859
<table width="100%" cellpadding="2" cellspacing="0" border="0">
 
860
  <tr>
 
861
    <td class="md">
 
862
      <table cellpadding="0" cellspacing="0" border="0">
 
863
        <tr>
 
864
          <td class="md" nowrap valign="top"> OggFLAC_API FLAC__bool OggFLAC__stream_decoder_set_metadata_ignore </td>
 
865
          <td class="md" valign="top">(&nbsp;</td>
 
866
          <td class="md" nowrap valign="top"><a class="el" href="structOggFLAC____StreamDecoder.html">OggFLAC__StreamDecoder</a> *&nbsp;</td>
 
867
          <td class="mdname" nowrap>&nbsp; <em>decoder</em>, </td>
 
868
        </tr>
 
869
        <tr>
 
870
          <td></td>
 
871
          <td></td>
 
872
          <td class="md" nowrap><a class="el" href="group__flac__format.html#a93">FLAC__MetadataType</a>&nbsp;</td>
 
873
          <td class="mdname" nowrap>&nbsp; <em>type</em></td>
 
874
        </tr>
 
875
        <tr>
 
876
          <td></td>
 
877
          <td class="md">)&nbsp;</td>
 
878
          <td class="md" colspan="2"></td>
 
879
        </tr>
 
880
 
 
881
      </table>
 
882
    </td>
 
883
  </tr>
 
884
</table>
 
885
<table cellspacing=5 cellpadding=0 border=0>
 
886
  <tr>
 
887
    <td>
 
888
      &nbsp;
 
889
    </td>
 
890
    <td>
 
891
 
 
892
<p>
 
893
Direct the decoder to filter out all metadata blocks of type <em>type</em>. 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>
 
894
Default Value:</b><dd>
 
895
 By default, only the <code>STREAMINFO</code> block is returned via the metadata callback. </dl><dl compact><dt><b>
 
896
Parameters: </b><dd>
 
897
<table border=0 cellspacing=2 cellpadding=0>
 
898
<tr><td valign=top><em>decoder</em>&nbsp;</td><td>
 
899
A decoder instance to set. </td></tr>
 
900
<tr><td valign=top><em>type</em>&nbsp;</td><td>
 
901
See above. </td></tr>
 
902
</table>
 
903
</dl><dl compact><dt><b>
 
904
Assertions:</b><dd>
 
905
 <div class="fragment"><pre>decoder != NULL 
 
906
</pre></div> <em>type</em> is valid </dl><dl compact><dt><b>
 
907
Return values: </b><dd>
 
908
<table border=0 cellspacing=2 cellpadding=0>
 
909
<tr><td valign=top><em>FLAC__bool</em>&nbsp;</td><td>
 
910
<code>false</code> if the decoder is already initialized, else <code>true</code>. </td></tr>
 
911
</table>
 
912
</dl>    </td>
 
913
  </tr>
 
914
</table>
 
915
<a name="a17" doxytag="stream_decoder.h::OggFLAC__stream_decoder_set_metadata_ignore_application"></a><p>
 
916
<table width="100%" cellpadding="2" cellspacing="0" border="0">
 
917
  <tr>
 
918
    <td class="md">
 
919
      <table cellpadding="0" cellspacing="0" border="0">
 
920
        <tr>
 
921
          <td class="md" nowrap valign="top"> OggFLAC_API FLAC__bool OggFLAC__stream_decoder_set_metadata_ignore_application </td>
 
922
          <td class="md" valign="top">(&nbsp;</td>
 
923
          <td class="md" nowrap valign="top"><a class="el" href="structOggFLAC____StreamDecoder.html">OggFLAC__StreamDecoder</a> *&nbsp;</td>
 
924
          <td class="mdname" nowrap>&nbsp; <em>decoder</em>, </td>
 
925
        </tr>
 
926
        <tr>
 
927
          <td></td>
 
928
          <td></td>
 
929
          <td class="md" nowrap>const FLAC__byte&nbsp;</td>
 
930
          <td class="mdname" nowrap>&nbsp; <em>id</em>[4]</td>
 
931
        </tr>
 
932
        <tr>
 
933
          <td></td>
 
934
          <td class="md">)&nbsp;</td>
 
935
          <td class="md" colspan="2"></td>
 
936
        </tr>
 
937
 
 
938
      </table>
 
939
    </td>
 
940
  </tr>
 
941
</table>
 
942
<table cellspacing=5 cellpadding=0 border=0>
 
943
  <tr>
 
944
    <td>
 
945
      &nbsp;
 
946
    </td>
 
947
    <td>
 
948
 
 
949
<p>
 
950
Direct the decoder to filter out all APPLICATION metadata blocks of the given <em>id</em>. 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>
 
951
Default Value:</b><dd>
 
952
 By default, only the <code>STREAMINFO</code> block is returned via the metadata callback. </dl><dl compact><dt><b>
 
953
Parameters: </b><dd>
 
954
<table border=0 cellspacing=2 cellpadding=0>
 
955
<tr><td valign=top><em>decoder</em>&nbsp;</td><td>
 
956
A decoder instance to set. </td></tr>
 
957
<tr><td valign=top><em>id</em>&nbsp;</td><td>
 
958
See above. </td></tr>
 
959
</table>
 
960
</dl><dl compact><dt><b>
 
961
Assertions:</b><dd>
 
962
 <div class="fragment"><pre>decoder != NULL 
 
963
</pre></div> <div class="fragment"><pre>id != NULL 
 
964
</pre></div> </dl><dl compact><dt><b>
 
965
Return values: </b><dd>
 
966
<table border=0 cellspacing=2 cellpadding=0>
 
967
<tr><td valign=top><em>FLAC__bool</em>&nbsp;</td><td>
 
968
<code>false</code> if the decoder is already initialized, else <code>true</code>. </td></tr>
 
969
</table>
 
970
</dl>    </td>
 
971
  </tr>
 
972
</table>
 
973
<a name="a18" doxytag="stream_decoder.h::OggFLAC__stream_decoder_set_metadata_ignore_all"></a><p>
 
974
<table width="100%" cellpadding="2" cellspacing="0" border="0">
 
975
  <tr>
 
976
    <td class="md">
 
977
      <table cellpadding="0" cellspacing="0" border="0">
 
978
        <tr>
 
979
          <td class="md" nowrap valign="top"> OggFLAC_API FLAC__bool OggFLAC__stream_decoder_set_metadata_ignore_all </td>
 
980
          <td class="md" valign="top">(&nbsp;</td>
 
981
          <td class="md" nowrap valign="top"><a class="el" href="structOggFLAC____StreamDecoder.html">OggFLAC__StreamDecoder</a> *&nbsp;</td>
 
982
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>decoder</em>          </td>
 
983
          <td class="md" valign="top">)&nbsp;</td>
 
984
          <td class="md" nowrap></td>
 
985
        </tr>
 
986
 
 
987
      </table>
 
988
    </td>
 
989
  </tr>
 
990
</table>
 
991
<table cellspacing=5 cellpadding=0 border=0>
 
992
  <tr>
 
993
    <td>
 
994
      &nbsp;
 
995
    </td>
 
996
    <td>
 
997
 
 
998
<p>
 
999
Direct the decoder to filter out all metadata blocks of any type. 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>
 
1000
Default Value:</b><dd>
 
1001
 By default, only the <code>STREAMINFO</code> block is returned via the metadata callback. </dl><dl compact><dt><b>
 
1002
Parameters: </b><dd>
 
1003
<table border=0 cellspacing=2 cellpadding=0>
 
1004
<tr><td valign=top><em>decoder</em>&nbsp;</td><td>
 
1005
A decoder instance to set. </td></tr>
 
1006
</table>
 
1007
</dl><dl compact><dt><b>
 
1008
Assertions:</b><dd>
 
1009
 <div class="fragment"><pre>decoder != NULL 
 
1010
</pre></div> </dl><dl compact><dt><b>
 
1011
Return values: </b><dd>
 
1012
<table border=0 cellspacing=2 cellpadding=0>
 
1013
<tr><td valign=top><em>FLAC__bool</em>&nbsp;</td><td>
 
1014
<code>false</code> if the decoder is already initialized, else <code>true</code>. </td></tr>
 
1015
</table>
 
1016
</dl>    </td>
 
1017
  </tr>
 
1018
</table>
 
1019
<a name="a19" doxytag="stream_decoder.h::OggFLAC__stream_decoder_get_state"></a><p>
 
1020
<table width="100%" cellpadding="2" cellspacing="0" border="0">
 
1021
  <tr>
 
1022
    <td class="md">
 
1023
      <table cellpadding="0" cellspacing="0" border="0">
 
1024
        <tr>
 
1025
          <td class="md" nowrap valign="top"> OggFLAC_API <a class="el" href="group__oggflac__stream__decoder.html#a33">OggFLAC__StreamDecoderState</a> OggFLAC__stream_decoder_get_state </td>
 
1026
          <td class="md" valign="top">(&nbsp;</td>
 
1027
          <td class="md" nowrap valign="top">const <a class="el" href="structOggFLAC____StreamDecoder.html">OggFLAC__StreamDecoder</a> *&nbsp;</td>
 
1028
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>decoder</em>          </td>
 
1029
          <td class="md" valign="top">)&nbsp;</td>
 
1030
          <td class="md" nowrap></td>
 
1031
        </tr>
 
1032
 
 
1033
      </table>
 
1034
    </td>
 
1035
  </tr>
 
1036
</table>
 
1037
<table cellspacing=5 cellpadding=0 border=0>
 
1038
  <tr>
 
1039
    <td>
 
1040
      &nbsp;
 
1041
    </td>
 
1042
    <td>
 
1043
 
 
1044
<p>
 
1045
Get the current decoder state.<dl compact><dt><b>
 
1046
Parameters: </b><dd>
 
1047
<table border=0 cellspacing=2 cellpadding=0>
 
1048
<tr><td valign=top><em>decoder</em>&nbsp;</td><td>
 
1049
A decoder instance to query. </td></tr>
 
1050
</table>
 
1051
</dl><dl compact><dt><b>
 
1052
Assertions:</b><dd>
 
1053
 <div class="fragment"><pre>decoder != NULL 
 
1054
</pre></div> </dl><dl compact><dt><b>
 
1055
Return values: </b><dd>
 
1056
<table border=0 cellspacing=2 cellpadding=0>
 
1057
<tr><td valign=top><em>OggFLAC__StreamDecoderState</em>&nbsp;</td><td>
 
1058
The current decoder state. </td></tr>
 
1059
</table>
 
1060
</dl>    </td>
 
1061
  </tr>
 
1062
</table>
 
1063
<a name="a20" doxytag="stream_decoder.h::OggFLAC__stream_decoder_get_FLAC_stream_decoder_state"></a><p>
 
1064
<table width="100%" cellpadding="2" cellspacing="0" border="0">
 
1065
  <tr>
 
1066
    <td class="md">
 
1067
      <table cellpadding="0" cellspacing="0" border="0">
 
1068
        <tr>
 
1069
          <td class="md" nowrap valign="top"> OggFLAC_API <a class="el" href="group__flac__stream__decoder.html#a34">FLAC__StreamDecoderState</a> OggFLAC__stream_decoder_get_FLAC_stream_decoder_state </td>
 
1070
          <td class="md" valign="top">(&nbsp;</td>
 
1071
          <td class="md" nowrap valign="top">const <a class="el" href="structOggFLAC____StreamDecoder.html">OggFLAC__StreamDecoder</a> *&nbsp;</td>
 
1072
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>decoder</em>          </td>
 
1073
          <td class="md" valign="top">)&nbsp;</td>
 
1074
          <td class="md" nowrap></td>
 
1075
        </tr>
 
1076
 
 
1077
      </table>
 
1078
    </td>
 
1079
  </tr>
 
1080
</table>
 
1081
<table cellspacing=5 cellpadding=0 border=0>
 
1082
  <tr>
 
1083
    <td>
 
1084
      &nbsp;
 
1085
    </td>
 
1086
    <td>
 
1087
 
 
1088
<p>
 
1089
Get the state of the underlying FLAC stream decoder. Useful when the stream decoder state is <code>OggFLAC__STREAM_DECODER_FLAC_STREAM_DECODER_ERROR</code>.<dl compact><dt><b>
 
1090
Parameters: </b><dd>
 
1091
<table border=0 cellspacing=2 cellpadding=0>
 
1092
<tr><td valign=top><em>decoder</em>&nbsp;</td><td>
 
1093
A decoder instance to query. </td></tr>
 
1094
</table>
 
1095
</dl><dl compact><dt><b>
 
1096
Assertions:</b><dd>
 
1097
 <div class="fragment"><pre>decoder != NULL 
 
1098
</pre></div> </dl><dl compact><dt><b>
 
1099
Return values: </b><dd>
 
1100
<table border=0 cellspacing=2 cellpadding=0>
 
1101
<tr><td valign=top><em>FLAC__StreamDecoderState</em>&nbsp;</td><td>
 
1102
The FLAC stream decoder state. </td></tr>
 
1103
</table>
 
1104
</dl>    </td>
 
1105
  </tr>
 
1106
</table>
 
1107
<a name="a21" doxytag="stream_decoder.h::OggFLAC__stream_decoder_get_channels"></a><p>
 
1108
<table width="100%" cellpadding="2" cellspacing="0" border="0">
 
1109
  <tr>
 
1110
    <td class="md">
 
1111
      <table cellpadding="0" cellspacing="0" border="0">
 
1112
        <tr>
 
1113
          <td class="md" nowrap valign="top"> OggFLAC_API unsigned OggFLAC__stream_decoder_get_channels </td>
 
1114
          <td class="md" valign="top">(&nbsp;</td>
 
1115
          <td class="md" nowrap valign="top">const <a class="el" href="structOggFLAC____StreamDecoder.html">OggFLAC__StreamDecoder</a> *&nbsp;</td>
 
1116
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>decoder</em>          </td>
 
1117
          <td class="md" valign="top">)&nbsp;</td>
 
1118
          <td class="md" nowrap></td>
 
1119
        </tr>
 
1120
 
 
1121
      </table>
 
1122
    </td>
 
1123
  </tr>
 
1124
</table>
 
1125
<table cellspacing=5 cellpadding=0 border=0>
 
1126
  <tr>
 
1127
    <td>
 
1128
      &nbsp;
 
1129
    </td>
 
1130
    <td>
 
1131
 
 
1132
<p>
 
1133
This is inherited from <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a>; see <a class="el" href="group__flac__stream__decoder.html#a22">FLAC__stream_decoder_get_channels</a>()<dl compact><dt><b>
 
1134
Parameters: </b><dd>
 
1135
<table border=0 cellspacing=2 cellpadding=0>
 
1136
<tr><td valign=top><em>decoder</em>&nbsp;</td><td>
 
1137
A decoder instance to query. </td></tr>
 
1138
</table>
 
1139
</dl><dl compact><dt><b>
 
1140
Assertions:</b><dd>
 
1141
 <div class="fragment"><pre>decoder != NULL 
 
1142
</pre></div> </dl><dl compact><dt><b>
 
1143
Return values: </b><dd>
 
1144
<table border=0 cellspacing=2 cellpadding=0>
 
1145
<tr><td valign=top><em>unsigned</em>&nbsp;</td><td>
 
1146
See above. </td></tr>
 
1147
</table>
 
1148
</dl>    </td>
 
1149
  </tr>
 
1150
</table>
 
1151
<a name="a22" doxytag="stream_decoder.h::OggFLAC__stream_decoder_get_channel_assignment"></a><p>
 
1152
<table width="100%" cellpadding="2" cellspacing="0" border="0">
 
1153
  <tr>
 
1154
    <td class="md">
 
1155
      <table cellpadding="0" cellspacing="0" border="0">
 
1156
        <tr>
 
1157
          <td class="md" nowrap valign="top"> OggFLAC_API <a class="el" href="group__flac__format.html#a91">FLAC__ChannelAssignment</a> OggFLAC__stream_decoder_get_channel_assignment </td>
 
1158
          <td class="md" valign="top">(&nbsp;</td>
 
1159
          <td class="md" nowrap valign="top">const <a class="el" href="structOggFLAC____StreamDecoder.html">OggFLAC__StreamDecoder</a> *&nbsp;</td>
 
1160
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>decoder</em>          </td>
 
1161
          <td class="md" valign="top">)&nbsp;</td>
 
1162
          <td class="md" nowrap></td>
 
1163
        </tr>
 
1164
 
 
1165
      </table>
 
1166
    </td>
 
1167
  </tr>
 
1168
</table>
 
1169
<table cellspacing=5 cellpadding=0 border=0>
 
1170
  <tr>
 
1171
    <td>
 
1172
      &nbsp;
 
1173
    </td>
 
1174
    <td>
 
1175
 
 
1176
<p>
 
1177
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_channel_assignment</a>()<dl compact><dt><b>
 
1178
Parameters: </b><dd>
 
1179
<table border=0 cellspacing=2 cellpadding=0>
 
1180
<tr><td valign=top><em>decoder</em>&nbsp;</td><td>
 
1181
A decoder instance to query. </td></tr>
 
1182
</table>
 
1183
</dl><dl compact><dt><b>
 
1184
Assertions:</b><dd>
 
1185
 <div class="fragment"><pre>decoder != NULL 
 
1186
</pre></div> </dl><dl compact><dt><b>
 
1187
Return values: </b><dd>
 
1188
<table border=0 cellspacing=2 cellpadding=0>
 
1189
<tr><td valign=top><em>OggFLAC__ChannelAssignment</em>&nbsp;</td><td>
 
1190
See above. </td></tr>
 
1191
</table>
 
1192
</dl>    </td>
 
1193
  </tr>
 
1194
</table>
 
1195
<a name="a23" doxytag="stream_decoder.h::OggFLAC__stream_decoder_get_bits_per_sample"></a><p>
 
1196
<table width="100%" cellpadding="2" cellspacing="0" border="0">
 
1197
  <tr>
 
1198
    <td class="md">
 
1199
      <table cellpadding="0" cellspacing="0" border="0">
 
1200
        <tr>
 
1201
          <td class="md" nowrap valign="top"> OggFLAC_API unsigned OggFLAC__stream_decoder_get_bits_per_sample </td>
 
1202
          <td class="md" valign="top">(&nbsp;</td>
 
1203
          <td class="md" nowrap valign="top">const <a class="el" href="structOggFLAC____StreamDecoder.html">OggFLAC__StreamDecoder</a> *&nbsp;</td>
 
1204
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>decoder</em>          </td>
 
1205
          <td class="md" valign="top">)&nbsp;</td>
 
1206
          <td class="md" nowrap></td>
 
1207
        </tr>
 
1208
 
 
1209
      </table>
 
1210
    </td>
 
1211
  </tr>
 
1212
</table>
 
1213
<table cellspacing=5 cellpadding=0 border=0>
 
1214
  <tr>
 
1215
    <td>
 
1216
      &nbsp;
 
1217
    </td>
 
1218
    <td>
 
1219
 
 
1220
<p>
 
1221
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_bits_per_sample</a>()<dl compact><dt><b>
 
1222
Parameters: </b><dd>
 
1223
<table border=0 cellspacing=2 cellpadding=0>
 
1224
<tr><td valign=top><em>decoder</em>&nbsp;</td><td>
 
1225
A decoder instance to query. </td></tr>
 
1226
</table>
 
1227
</dl><dl compact><dt><b>
 
1228
Assertions:</b><dd>
 
1229
 <div class="fragment"><pre>decoder != NULL 
 
1230
</pre></div> </dl><dl compact><dt><b>
 
1231
Return values: </b><dd>
 
1232
<table border=0 cellspacing=2 cellpadding=0>
 
1233
<tr><td valign=top><em>unsigned</em>&nbsp;</td><td>
 
1234
See above. </td></tr>
 
1235
</table>
 
1236
</dl>    </td>
 
1237
  </tr>
 
1238
</table>
 
1239
<a name="a24" doxytag="stream_decoder.h::OggFLAC__stream_decoder_get_sample_rate"></a><p>
 
1240
<table width="100%" cellpadding="2" cellspacing="0" border="0">
 
1241
  <tr>
 
1242
    <td class="md">
 
1243
      <table cellpadding="0" cellspacing="0" border="0">
 
1244
        <tr>
 
1245
          <td class="md" nowrap valign="top"> OggFLAC_API unsigned OggFLAC__stream_decoder_get_sample_rate </td>
 
1246
          <td class="md" valign="top">(&nbsp;</td>
 
1247
          <td class="md" nowrap valign="top">const <a class="el" href="structOggFLAC____StreamDecoder.html">OggFLAC__StreamDecoder</a> *&nbsp;</td>
 
1248
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>decoder</em>          </td>
 
1249
          <td class="md" valign="top">)&nbsp;</td>
 
1250
          <td class="md" nowrap></td>
 
1251
        </tr>
 
1252
 
 
1253
      </table>
 
1254
    </td>
 
1255
  </tr>
 
1256
</table>
 
1257
<table cellspacing=5 cellpadding=0 border=0>
 
1258
  <tr>
 
1259
    <td>
 
1260
      &nbsp;
 
1261
    </td>
 
1262
    <td>
 
1263
 
 
1264
<p>
 
1265
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_sample_rate</a>()<dl compact><dt><b>
 
1266
Parameters: </b><dd>
 
1267
<table border=0 cellspacing=2 cellpadding=0>
 
1268
<tr><td valign=top><em>decoder</em>&nbsp;</td><td>
 
1269
A decoder instance to query. </td></tr>
 
1270
</table>
 
1271
</dl><dl compact><dt><b>
 
1272
Assertions:</b><dd>
 
1273
 <div class="fragment"><pre>decoder != NULL 
 
1274
</pre></div> </dl><dl compact><dt><b>
 
1275
Return values: </b><dd>
 
1276
<table border=0 cellspacing=2 cellpadding=0>
 
1277
<tr><td valign=top><em>unsigned</em>&nbsp;</td><td>
 
1278
See above. </td></tr>
 
1279
</table>
 
1280
</dl>    </td>
 
1281
  </tr>
 
1282
</table>
 
1283
<a name="a25" doxytag="stream_decoder.h::OggFLAC__stream_decoder_get_blocksize"></a><p>
 
1284
<table width="100%" cellpadding="2" cellspacing="0" border="0">
 
1285
  <tr>
 
1286
    <td class="md">
 
1287
      <table cellpadding="0" cellspacing="0" border="0">
 
1288
        <tr>
 
1289
          <td class="md" nowrap valign="top"> OggFLAC_API unsigned OggFLAC__stream_decoder_get_blocksize </td>
 
1290
          <td class="md" valign="top">(&nbsp;</td>
 
1291
          <td class="md" nowrap valign="top">const <a class="el" href="structOggFLAC____StreamDecoder.html">OggFLAC__StreamDecoder</a> *&nbsp;</td>
 
1292
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>decoder</em>          </td>
 
1293
          <td class="md" valign="top">)&nbsp;</td>
 
1294
          <td class="md" nowrap></td>
 
1295
        </tr>
 
1296
 
 
1297
      </table>
 
1298
    </td>
 
1299
  </tr>
 
1300
</table>
 
1301
<table cellspacing=5 cellpadding=0 border=0>
 
1302
  <tr>
 
1303
    <td>
 
1304
      &nbsp;
 
1305
    </td>
 
1306
    <td>
 
1307
 
 
1308
<p>
 
1309
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_blocksize</a>()<dl compact><dt><b>
 
1310
Parameters: </b><dd>
 
1311
<table border=0 cellspacing=2 cellpadding=0>
 
1312
<tr><td valign=top><em>decoder</em>&nbsp;</td><td>
 
1313
A decoder instance to query. </td></tr>
 
1314
</table>
 
1315
</dl><dl compact><dt><b>
 
1316
Assertions:</b><dd>
 
1317
 <div class="fragment"><pre>decoder != NULL 
 
1318
</pre></div> </dl><dl compact><dt><b>
 
1319
Return values: </b><dd>
 
1320
<table border=0 cellspacing=2 cellpadding=0>
 
1321
<tr><td valign=top><em>unsigned</em>&nbsp;</td><td>
 
1322
See above. </td></tr>
 
1323
</table>
 
1324
</dl>    </td>
 
1325
  </tr>
 
1326
</table>
 
1327
<a name="a26" doxytag="stream_decoder.h::OggFLAC__stream_decoder_init"></a><p>
 
1328
<table width="100%" cellpadding="2" cellspacing="0" border="0">
 
1329
  <tr>
 
1330
    <td class="md">
 
1331
      <table cellpadding="0" cellspacing="0" border="0">
 
1332
        <tr>
 
1333
          <td class="md" nowrap valign="top"> OggFLAC_API <a class="el" href="group__oggflac__stream__decoder.html#a33">OggFLAC__StreamDecoderState</a> OggFLAC__stream_decoder_init </td>
 
1334
          <td class="md" valign="top">(&nbsp;</td>
 
1335
          <td class="md" nowrap valign="top"><a class="el" href="structOggFLAC____StreamDecoder.html">OggFLAC__StreamDecoder</a> *&nbsp;</td>
 
1336
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>decoder</em>          </td>
 
1337
          <td class="md" valign="top">)&nbsp;</td>
 
1338
          <td class="md" nowrap></td>
 
1339
        </tr>
 
1340
 
 
1341
      </table>
 
1342
    </td>
 
1343
  </tr>
 
1344
</table>
 
1345
<table cellspacing=5 cellpadding=0 border=0>
 
1346
  <tr>
 
1347
    <td>
 
1348
      &nbsp;
 
1349
    </td>
 
1350
    <td>
 
1351
 
 
1352
<p>
 
1353
Initialize the decoder instance. Should be called after <a class="el" href="group__oggflac__stream__decoder.html#a5">OggFLAC__stream_decoder_new</a>() and OggFLAC__stream_decoder_set_*() but before any of the OggFLAC__stream_decoder_process_*() functions. Will set and return the decoder state, which will be OggFLAC__STREAM_DECODER_OK if initialization succeeded.<dl compact><dt><b>
 
1354
Parameters: </b><dd>
 
1355
<table border=0 cellspacing=2 cellpadding=0>
 
1356
<tr><td valign=top><em>decoder</em>&nbsp;</td><td>
 
1357
An uninitialized decoder instance. </td></tr>
 
1358
</table>
 
1359
</dl><dl compact><dt><b>
 
1360
Assertions:</b><dd>
 
1361
 <div class="fragment"><pre>decoder != NULL 
 
1362
</pre></div> </dl><dl compact><dt><b>
 
1363
Return values: </b><dd>
 
1364
<table border=0 cellspacing=2 cellpadding=0>
 
1365
<tr><td valign=top><em>OggFLAC__StreamDecoderState</em>&nbsp;</td><td>
 
1366
<code>OggFLAC__STREAM_DECODER_OK</code> if initialization was successful; see OggFLAC__StreamDecoderState for the meanings of other return values. </td></tr>
 
1367
</table>
 
1368
</dl>    </td>
 
1369
  </tr>
 
1370
</table>
 
1371
<a name="a27" doxytag="stream_decoder.h::OggFLAC__stream_decoder_finish"></a><p>
 
1372
<table width="100%" cellpadding="2" cellspacing="0" border="0">
 
1373
  <tr>
 
1374
    <td class="md">
 
1375
      <table cellpadding="0" cellspacing="0" border="0">
 
1376
        <tr>
 
1377
          <td class="md" nowrap valign="top"> OggFLAC_API void OggFLAC__stream_decoder_finish </td>
 
1378
          <td class="md" valign="top">(&nbsp;</td>
 
1379
          <td class="md" nowrap valign="top"><a class="el" href="structOggFLAC____StreamDecoder.html">OggFLAC__StreamDecoder</a> *&nbsp;</td>
 
1380
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>decoder</em>          </td>
 
1381
          <td class="md" valign="top">)&nbsp;</td>
 
1382
          <td class="md" nowrap></td>
 
1383
        </tr>
 
1384
 
 
1385
      </table>
 
1386
    </td>
 
1387
  </tr>
 
1388
</table>
 
1389
<table cellspacing=5 cellpadding=0 border=0>
 
1390
  <tr>
 
1391
    <td>
 
1392
      &nbsp;
 
1393
    </td>
 
1394
    <td>
 
1395
 
 
1396
<p>
 
1397
Finish the decoding process. Flushes the decoding buffer, releases resources, resets the decoder settings to their defaults, and returns the decoder state to OggFLAC__STREAM_DECODER_UNINITIALIZED.
 
1398
<p>
 
1399
In the event of a prematurely-terminated decode, it is not strictly necessary to call this immediately before <a class="el" href="group__oggflac__stream__decoder.html#a6">OggFLAC__stream_decoder_delete</a>() but it is good practice to match every <a class="el" href="group__oggflac__stream__decoder.html#a26">OggFLAC__stream_decoder_init</a>() with an <a class="el" href="group__oggflac__stream__decoder.html#a27">OggFLAC__stream_decoder_finish</a>().<dl compact><dt><b>
 
1400
Parameters: </b><dd>
 
1401
<table border=0 cellspacing=2 cellpadding=0>
 
1402
<tr><td valign=top><em>decoder</em>&nbsp;</td><td>
 
1403
An uninitialized decoder instance. </td></tr>
 
1404
</table>
 
1405
</dl><dl compact><dt><b>
 
1406
Assertions:</b><dd>
 
1407
 <div class="fragment"><pre>decoder != NULL 
 
1408
</pre></div> </dl>    </td>
 
1409
  </tr>
 
1410
</table>
 
1411
<a name="a28" doxytag="stream_decoder.h::OggFLAC__stream_decoder_flush"></a><p>
 
1412
<table width="100%" cellpadding="2" cellspacing="0" border="0">
 
1413
  <tr>
 
1414
    <td class="md">
 
1415
      <table cellpadding="0" cellspacing="0" border="0">
 
1416
        <tr>
 
1417
          <td class="md" nowrap valign="top"> OggFLAC_API FLAC__bool OggFLAC__stream_decoder_flush </td>
 
1418
          <td class="md" valign="top">(&nbsp;</td>
 
1419
          <td class="md" nowrap valign="top"><a class="el" href="structOggFLAC____StreamDecoder.html">OggFLAC__StreamDecoder</a> *&nbsp;</td>
 
1420
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>decoder</em>          </td>
 
1421
          <td class="md" valign="top">)&nbsp;</td>
 
1422
          <td class="md" nowrap></td>
 
1423
        </tr>
 
1424
 
 
1425
      </table>
 
1426
    </td>
 
1427
  </tr>
 
1428
</table>
 
1429
<table cellspacing=5 cellpadding=0 border=0>
 
1430
  <tr>
 
1431
    <td>
 
1432
      &nbsp;
 
1433
    </td>
 
1434
    <td>
 
1435
 
 
1436
<p>
 
1437
This is inherited from <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a>; see <a class="el" href="group__flac__stream__decoder.html#a29">FLAC__stream_decoder_flush</a>()<dl compact><dt><b>
 
1438
Parameters: </b><dd>
 
1439
<table border=0 cellspacing=2 cellpadding=0>
 
1440
<tr><td valign=top><em>decoder</em>&nbsp;</td><td>
 
1441
A decoder instance. </td></tr>
 
1442
</table>
 
1443
</dl><dl compact><dt><b>
 
1444
Assertions:</b><dd>
 
1445
 <div class="fragment"><pre>decoder != NULL 
 
1446
</pre></div> </dl><dl compact><dt><b>
 
1447
Return values: </b><dd>
 
1448
<table border=0 cellspacing=2 cellpadding=0>
 
1449
<tr><td valign=top><em>FLAC__bool</em>&nbsp;</td><td>
 
1450
<code>true</code> if successful, else <code>false</code> if a memory allocation error occurs. </td></tr>
 
1451
</table>
 
1452
</dl>    </td>
 
1453
  </tr>
 
1454
</table>
 
1455
<a name="a29" doxytag="stream_decoder.h::OggFLAC__stream_decoder_reset"></a><p>
 
1456
<table width="100%" cellpadding="2" cellspacing="0" border="0">
 
1457
  <tr>
 
1458
    <td class="md">
 
1459
      <table cellpadding="0" cellspacing="0" border="0">
 
1460
        <tr>
 
1461
          <td class="md" nowrap valign="top"> OggFLAC_API FLAC__bool OggFLAC__stream_decoder_reset </td>
 
1462
          <td class="md" valign="top">(&nbsp;</td>
 
1463
          <td class="md" nowrap valign="top"><a class="el" href="structOggFLAC____StreamDecoder.html">OggFLAC__StreamDecoder</a> *&nbsp;</td>
 
1464
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>decoder</em>          </td>
 
1465
          <td class="md" valign="top">)&nbsp;</td>
 
1466
          <td class="md" nowrap></td>
 
1467
        </tr>
 
1468
 
 
1469
      </table>
 
1470
    </td>
 
1471
  </tr>
 
1472
</table>
 
1473
<table cellspacing=5 cellpadding=0 border=0>
 
1474
  <tr>
 
1475
    <td>
 
1476
      &nbsp;
 
1477
    </td>
 
1478
    <td>
 
1479
 
 
1480
<p>
 
1481
This is inherited from <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a>; see <a class="el" href="group__flac__stream__decoder.html#a30">FLAC__stream_decoder_reset</a>()<dl compact><dt><b>
 
1482
Parameters: </b><dd>
 
1483
<table border=0 cellspacing=2 cellpadding=0>
 
1484
<tr><td valign=top><em>decoder</em>&nbsp;</td><td>
 
1485
A decoder instance. </td></tr>
 
1486
</table>
 
1487
</dl><dl compact><dt><b>
 
1488
Assertions:</b><dd>
 
1489
 <div class="fragment"><pre>decoder != NULL 
 
1490
</pre></div> </dl><dl compact><dt><b>
 
1491
Return values: </b><dd>
 
1492
<table border=0 cellspacing=2 cellpadding=0>
 
1493
<tr><td valign=top><em>FLAC__bool</em>&nbsp;</td><td>
 
1494
<code>true</code> if successful, else <code>false</code> if a memory allocation error occurs. </td></tr>
 
1495
</table>
 
1496
</dl>    </td>
 
1497
  </tr>
 
1498
</table>
 
1499
<a name="a30" doxytag="stream_decoder.h::OggFLAC__stream_decoder_process_single"></a><p>
 
1500
<table width="100%" cellpadding="2" cellspacing="0" border="0">
 
1501
  <tr>
 
1502
    <td class="md">
 
1503
      <table cellpadding="0" cellspacing="0" border="0">
 
1504
        <tr>
 
1505
          <td class="md" nowrap valign="top"> OggFLAC_API FLAC__bool OggFLAC__stream_decoder_process_single </td>
 
1506
          <td class="md" valign="top">(&nbsp;</td>
 
1507
          <td class="md" nowrap valign="top"><a class="el" href="structOggFLAC____StreamDecoder.html">OggFLAC__StreamDecoder</a> *&nbsp;</td>
 
1508
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>decoder</em>          </td>
 
1509
          <td class="md" valign="top">)&nbsp;</td>
 
1510
          <td class="md" nowrap></td>
 
1511
        </tr>
 
1512
 
 
1513
      </table>
 
1514
    </td>
 
1515
  </tr>
 
1516
</table>
 
1517
<table cellspacing=5 cellpadding=0 border=0>
 
1518
  <tr>
 
1519
    <td>
 
1520
      &nbsp;
 
1521
    </td>
 
1522
    <td>
 
1523
 
 
1524
<p>
 
1525
Decode one metadata block or audio frame. This is inherited from <a class="el" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a>; see <a class="el" href="group__flac__stream__decoder.html#a31">FLAC__stream_decoder_process_single</a>()<dl compact><dt><b>
 
1526
Parameters: </b><dd>
 
1527
<table border=0 cellspacing=2 cellpadding=0>
 
1528
<tr><td valign=top><em>decoder</em>&nbsp;</td><td>
 
1529
An initialized decoder instance in the state <code>OggFLAC__STREAM_DECODER_OK</code>. </td></tr>
 
1530
</table>
 
1531
</dl><dl compact><dt><b>
 
1532
Assertions:</b><dd>
 
1533
 <div class="fragment"><pre>decoder != NULL 
 
1534
</pre></div> <div class="fragment"><pre><a class="code" href="OggFLAC_2stream__decoder_8h.html#a19">OggFLAC__stream_decoder_get_state</a>(decoder) == <a class="code" href="OggFLAC_2stream__decoder_8h.html#a33a5">OggFLAC__STREAM_DECODER_OK</a> 
 
1535
</pre></div> </dl><dl compact><dt><b>
 
1536
Return values: </b><dd>
 
1537
<table border=0 cellspacing=2 cellpadding=0>
 
1538
<tr><td valign=top><em>FLAC__bool</em>&nbsp;</td><td>
 
1539
<code>false</code> if any read or write error occurred (except <code>FLAC__STREAM_DECODER_ERROR_STATUS_LOST_SYNC)</code>, else <code>true</code>; in any case, check the decoder state with <a class="el" href="group__oggflac__stream__decoder.html#a19">OggFLAC__stream_decoder_get_state</a>() to see what went wrong or to check for lost synchronization (a sign of stream corruption). </td></tr>
 
1540
</table>
 
1541
</dl>    </td>
 
1542
  </tr>
 
1543
</table>
 
1544
<a name="a31" doxytag="stream_decoder.h::OggFLAC__stream_decoder_process_until_end_of_metadata"></a><p>
 
1545
<table width="100%" cellpadding="2" cellspacing="0" border="0">
 
1546
  <tr>
 
1547
    <td class="md">
 
1548
      <table cellpadding="0" cellspacing="0" border="0">
 
1549
        <tr>
 
1550
          <td class="md" nowrap valign="top"> OggFLAC_API FLAC__bool OggFLAC__stream_decoder_process_until_end_of_metadata </td>
 
1551
          <td class="md" valign="top">(&nbsp;</td>
 
1552
          <td class="md" nowrap valign="top"><a class="el" href="structOggFLAC____StreamDecoder.html">OggFLAC__StreamDecoder</a> *&nbsp;</td>
 
1553
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>decoder</em>          </td>
 
1554
          <td class="md" valign="top">)&nbsp;</td>
 
1555
          <td class="md" nowrap></td>
 
1556
        </tr>
 
1557
 
 
1558
      </table>
 
1559
    </td>
 
1560
  </tr>
 
1561
</table>
 
1562
<table cellspacing=5 cellpadding=0 border=0>
 
1563
  <tr>
 
1564
    <td>
 
1565
      &nbsp;
 
1566
    </td>
 
1567
    <td>
 
1568
 
 
1569
<p>
 
1570
Decode until the end of the metadata. 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_until_end_of_metadata</a>()<dl compact><dt><b>
 
1571
Parameters: </b><dd>
 
1572
<table border=0 cellspacing=2 cellpadding=0>
 
1573
<tr><td valign=top><em>decoder</em>&nbsp;</td><td>
 
1574
An initialized decoder instance in the state <code>OggFLAC__STREAM_DECODER_OK</code>. </td></tr>
 
1575
</table>
 
1576
</dl><dl compact><dt><b>
 
1577
Assertions:</b><dd>
 
1578
 <div class="fragment"><pre>decoder != NULL 
 
1579
</pre></div> <div class="fragment"><pre><a class="code" href="OggFLAC_2stream__decoder_8h.html#a19">OggFLAC__stream_decoder_get_state</a>(decoder) == <a class="code" href="OggFLAC_2stream__decoder_8h.html#a33a5">OggFLAC__STREAM_DECODER_OK</a> 
 
1580
</pre></div> </dl><dl compact><dt><b>
 
1581
Return values: </b><dd>
 
1582
<table border=0 cellspacing=2 cellpadding=0>
 
1583
<tr><td valign=top><em>FLAC__bool</em>&nbsp;</td><td>
 
1584
<code>false</code> if any read or write error occurred (except <code>OggFLAC__STREAM_DECODER_ERROR_STATUS_LOST_SYNC)</code>, else <code>true</code>; in any case, check the decoder state with <a class="el" href="group__oggflac__stream__decoder.html#a19">OggFLAC__stream_decoder_get_state</a>() to see what went wrong or to check for lost synchronization (a sign of stream corruption). </td></tr>
 
1585
</table>
 
1586
</dl>    </td>
 
1587
  </tr>
 
1588
</table>
 
1589
<a name="a32" doxytag="stream_decoder.h::OggFLAC__stream_decoder_process_until_end_of_stream"></a><p>
 
1590
<table width="100%" cellpadding="2" cellspacing="0" border="0">
 
1591
  <tr>
 
1592
    <td class="md">
 
1593
      <table cellpadding="0" cellspacing="0" border="0">
 
1594
        <tr>
 
1595
          <td class="md" nowrap valign="top"> OggFLAC_API FLAC__bool OggFLAC__stream_decoder_process_until_end_of_stream </td>
 
1596
          <td class="md" valign="top">(&nbsp;</td>
 
1597
          <td class="md" nowrap valign="top"><a class="el" href="structOggFLAC____StreamDecoder.html">OggFLAC__StreamDecoder</a> *&nbsp;</td>
 
1598
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>decoder</em>          </td>
 
1599
          <td class="md" valign="top">)&nbsp;</td>
 
1600
          <td class="md" nowrap></td>
 
1601
        </tr>
 
1602
 
 
1603
      </table>
 
1604
    </td>
 
1605
  </tr>
 
1606
</table>
 
1607
<table cellspacing=5 cellpadding=0 border=0>
 
1608
  <tr>
 
1609
    <td>
 
1610
      &nbsp;
 
1611
    </td>
 
1612
    <td>
 
1613
 
 
1614
<p>
 
1615
Decode until the end of the stream. 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_stream</a>()<dl compact><dt><b>
 
1616
Parameters: </b><dd>
 
1617
<table border=0 cellspacing=2 cellpadding=0>
 
1618
<tr><td valign=top><em>decoder</em>&nbsp;</td><td>
 
1619
An initialized decoder instance in the state <code>OggFLAC__STREAM_DECODER_OK</code>. </td></tr>
 
1620
</table>
 
1621
</dl><dl compact><dt><b>
 
1622
Assertions:</b><dd>
 
1623
 <div class="fragment"><pre>decoder != NULL 
 
1624
</pre></div> <div class="fragment"><pre><a class="code" href="OggFLAC_2stream__decoder_8h.html#a19">OggFLAC__stream_decoder_get_state</a>(decoder) == <a class="code" href="OggFLAC_2stream__decoder_8h.html#a33a5">OggFLAC__STREAM_DECODER_OK</a> 
 
1625
</pre></div> </dl><dl compact><dt><b>
 
1626
Return values: </b><dd>
 
1627
<table border=0 cellspacing=2 cellpadding=0>
 
1628
<tr><td valign=top><em>FLAC__bool</em>&nbsp;</td><td>
 
1629
<code>false</code> if any read or write error occurred (except <code>OggFLAC__STREAM_DECODER_ERROR_STATUS_LOST_SYNC)</code>, else <code>true</code>; in any case, check the decoder state with <a class="el" href="group__oggflac__stream__decoder.html#a19">OggFLAC__stream_decoder_get_state</a>() to see what went wrong or to check for lost synchronization (a sign of stream corruption). </td></tr>
 
1630
</table>
 
1631
</dl>    </td>
 
1632
  </tr>
 
1633
</table>
 
1634
<hr><h2>Variable Documentation</h2>
 
1635
<a name="a0" doxytag="stream_decoder.h::OggFLAC__StreamDecoderStateString"></a><p>
 
1636
<table width="100%" cellpadding="2" cellspacing="0" border="0">
 
1637
  <tr>
 
1638
    <td class="md">
 
1639
      <table cellpadding="0" cellspacing="0" border="0">
 
1640
        <tr>
 
1641
          <td class="md" nowrap valign="top"> OggFLAC_API const char* const OggFLAC__StreamDecoderStateString[]
 
1642
      </table>
 
1643
    </td>
 
1644
  </tr>
 
1645
</table>
 
1646
<table cellspacing=5 cellpadding=0 border=0>
 
1647
  <tr>
 
1648
    <td>
 
1649
      &nbsp;
 
1650
    </td>
 
1651
    <td>
 
1652
 
 
1653
<p>
 
1654
Maps an OggFLAC__StreamDecoderState to a C string.
 
1655
<p>
 
1656
Using an OggFLAC__StreamDecoderState as the index to this array will give the string equivalent. The contents should not be modified.     </td>
 
1657
  </tr>
 
1658
</table>
 
1659
<hr><address><small>Generated on Sat Jan 25 10:44:58 2003 for FLAC by
 
1660
<a href="http://www.doxygen.org/index.html">
 
1661
<img src="doxygen.gif" alt="doxygen" align="middle" border=0 
 
1662
width=110 height=53></a>1.2.14 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>,
 
1663
 &copy;&nbsp;1997-2002</small></address>
 
1664
</body>
 
1665
</html>