~ubuntu-branches/ubuntu/precise/flac/precise-updates

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Joshua Kwan
  • Date: 2007-05-29 22:56:36 UTC
  • mfrom: (1.1.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20070529225636-ljeff8xxip09qaap
Tags: 1.1.4-1
* New upstream release. closes: #405167, #411311
  - libOggFLAC and libOggFLAC++ have been merged into libFLAC, so
    remove their corresponding packages.
  - Because of the API changes required to effect the above, there has
    been yet another soname bump. libflac7 -> libflac8 and
    libflac++5 -> libflac++6. Emails have been dispatched to the
    maintainers of dependent packages.
* Some notes on patches that were removed:
  - 02_stdin_stdout, 06_manpage_mention_utf8_convert: merged upstream
  - 08_manpage_warnings: Upstream has changed the manpage so it defintely
    can't fit in in 80 cols, so just forget about it. We'll live.
  - 05_eof_warnings_are_errors: Upstream decided to add a -w option to
    flac to treat all warnings as errors. I am going to defer to that
    for now, but if people think it's stupid let me know and I'll port
    the patch forward.
  - 04_stack_smasher: was a backport from 1.1.3, so it's obsolete.

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>file_decoder.h File Reference</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>include/FLAC/file_decoder.h File Reference</h1>This module contains the functions which implement the file decoder. 
10
 
<a href="#_details">More...</a>
11
 
<p>
12
 
<code>#include "export.h"</code><br>
13
 
<code>#include "<a class="el" href="seekable__stream__decoder_8h-source.html">seekable_stream_decoder.h</a>"</code><br>
14
 
 
15
 
<p>
16
 
<a href="file__decoder_8h-source.html">Go to the source code of this file.</a><table border=0 cellpadding=0 cellspacing=0>
17
 
<tr><td colspan=2><br><h2>Compounds</h2></td></tr>
18
 
<tr><td nowrap align=right valign=top>struct &nbsp;</td><td valign=bottom><a class="el" href="structFLAC____FileDecoder.html">FLAC__FileDecoder</a></td></tr>
19
 
<tr><td colspan=2><br><h2>Typedefs</h2></td></tr>
20
 
<tr><td nowrap align=right valign=top>typedef <a class="el" href="group__flac__stream__decoder.html#a38">FLAC__StreamDecoderWriteStatus</a>(*&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__decoder.html#a1">FLAC__FileDecoderWriteCallback</a> )(const <a class="el" href="structFLAC____FileDecoder.html">FLAC__FileDecoder</a> *decoder, const <a class="el" href="structFLAC____Frame.html">FLAC__Frame</a> *frame, const FLAC__int32 *const buffer[], void *client_data)</td></tr>
21
 
<tr><td nowrap align=right valign=top>typedef void(*&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__decoder.html#a2">FLAC__FileDecoderMetadataCallback</a> )(const <a class="el" href="structFLAC____FileDecoder.html">FLAC__FileDecoder</a> *decoder, const <a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> *metadata, void *client_data)</td></tr>
22
 
<tr><td nowrap align=right valign=top>typedef void(*&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__decoder.html#a3">FLAC__FileDecoderErrorCallback</a> )(const <a class="el" href="structFLAC____FileDecoder.html">FLAC__FileDecoder</a> *decoder, <a class="el" href="group__flac__stream__decoder.html#a39">FLAC__StreamDecoderErrorStatus</a> status, void *client_data)</td></tr>
23
 
<tr><td colspan=2><br><h2>Enumerations</h2></td></tr>
24
 
<tr><td nowrap align=right valign=top>enum &nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__decoder.html#a36">FLAC__FileDecoderState</a> { <br>
25
 
&nbsp;&nbsp;<a class="el" href="group__flac__file__decoder.html#a36a4">FLAC__FILE_DECODER_OK</a> =  0, 
26
 
<a class="el" href="group__flac__file__decoder.html#a36a5">FLAC__FILE_DECODER_END_OF_FILE</a>, 
27
 
<a class="el" href="group__flac__file__decoder.html#a36a6">FLAC__FILE_DECODER_ERROR_OPENING_FILE</a>, 
28
 
<a class="el" href="group__flac__file__decoder.html#a36a7">FLAC__FILE_DECODER_MEMORY_ALLOCATION_ERROR</a>, 
29
 
<br>
30
 
&nbsp;&nbsp;<a class="el" href="group__flac__file__decoder.html#a36a8">FLAC__FILE_DECODER_SEEK_ERROR</a>, 
31
 
<a class="el" href="group__flac__file__decoder.html#a36a9">FLAC__FILE_DECODER_SEEKABLE_STREAM_DECODER_ERROR</a>, 
32
 
<a class="el" href="group__flac__file__decoder.html#a36a10">FLAC__FILE_DECODER_ALREADY_INITIALIZED</a>, 
33
 
<a class="el" href="group__flac__file__decoder.html#a36a11">FLAC__FILE_DECODER_INVALID_CALLBACK</a>, 
34
 
<br>
35
 
&nbsp;&nbsp;<a class="el" href="group__flac__file__decoder.html#a36a12">FLAC__FILE_DECODER_UNINITIALIZED</a>
36
 
<br>
37
 
 }</td></tr>
38
 
<tr><td colspan=2><br><h2>Functions</h2></td></tr>
39
 
<tr><td nowrap align=right valign=top><a class="el" href="structFLAC____FileDecoder.html">FLAC__FileDecoder</a> *&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__decoder.html#a4">FLAC__file_decoder_new</a> ()</td></tr>
40
 
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__decoder.html#a5">FLAC__file_decoder_delete</a> (<a class="el" href="structFLAC____FileDecoder.html">FLAC__FileDecoder</a> *decoder)</td></tr>
41
 
<tr><td nowrap align=right valign=top>FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__decoder.html#a6">FLAC__file_decoder_set_md5_checking</a> (<a class="el" href="structFLAC____FileDecoder.html">FLAC__FileDecoder</a> *decoder, FLAC__bool value)</td></tr>
42
 
<tr><td nowrap align=right valign=top>FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__decoder.html#a7">FLAC__file_decoder_set_filename</a> (<a class="el" href="structFLAC____FileDecoder.html">FLAC__FileDecoder</a> *decoder, const char *value)</td></tr>
43
 
<tr><td nowrap align=right valign=top>FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__decoder.html#a8">FLAC__file_decoder_set_write_callback</a> (<a class="el" href="structFLAC____FileDecoder.html">FLAC__FileDecoder</a> *decoder, <a class="el" href="group__flac__file__decoder.html#a1">FLAC__FileDecoderWriteCallback</a> value)</td></tr>
44
 
<tr><td nowrap align=right valign=top>FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__decoder.html#a9">FLAC__file_decoder_set_metadata_callback</a> (<a class="el" href="structFLAC____FileDecoder.html">FLAC__FileDecoder</a> *decoder, <a class="el" href="group__flac__file__decoder.html#a2">FLAC__FileDecoderMetadataCallback</a> value)</td></tr>
45
 
<tr><td nowrap align=right valign=top>FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__decoder.html#a10">FLAC__file_decoder_set_error_callback</a> (<a class="el" href="structFLAC____FileDecoder.html">FLAC__FileDecoder</a> *decoder, <a class="el" href="group__flac__file__decoder.html#a3">FLAC__FileDecoderErrorCallback</a> value)</td></tr>
46
 
<tr><td nowrap align=right valign=top>FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__decoder.html#a11">FLAC__file_decoder_set_client_data</a> (<a class="el" href="structFLAC____FileDecoder.html">FLAC__FileDecoder</a> *decoder, void *value)</td></tr>
47
 
<tr><td nowrap align=right valign=top>FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__decoder.html#a12">FLAC__file_decoder_set_metadata_respond</a> (<a class="el" href="structFLAC____FileDecoder.html">FLAC__FileDecoder</a> *decoder, <a class="el" href="group__flac__format.html#a97">FLAC__MetadataType</a> type)</td></tr>
48
 
<tr><td nowrap align=right valign=top>FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__decoder.html#a13">FLAC__file_decoder_set_metadata_respond_application</a> (<a class="el" href="structFLAC____FileDecoder.html">FLAC__FileDecoder</a> *decoder, const FLAC__byte id[4])</td></tr>
49
 
<tr><td nowrap align=right valign=top>FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__decoder.html#a14">FLAC__file_decoder_set_metadata_respond_all</a> (<a class="el" href="structFLAC____FileDecoder.html">FLAC__FileDecoder</a> *decoder)</td></tr>
50
 
<tr><td nowrap align=right valign=top>FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__decoder.html#a15">FLAC__file_decoder_set_metadata_ignore</a> (<a class="el" href="structFLAC____FileDecoder.html">FLAC__FileDecoder</a> *decoder, <a class="el" href="group__flac__format.html#a97">FLAC__MetadataType</a> type)</td></tr>
51
 
<tr><td nowrap align=right valign=top>FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__decoder.html#a16">FLAC__file_decoder_set_metadata_ignore_application</a> (<a class="el" href="structFLAC____FileDecoder.html">FLAC__FileDecoder</a> *decoder, const FLAC__byte id[4])</td></tr>
52
 
<tr><td nowrap align=right valign=top>FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__decoder.html#a17">FLAC__file_decoder_set_metadata_ignore_all</a> (<a class="el" href="structFLAC____FileDecoder.html">FLAC__FileDecoder</a> *decoder)</td></tr>
53
 
<tr><td nowrap align=right valign=top><a class="el" href="group__flac__file__decoder.html#a36">FLAC__FileDecoderState</a>&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__decoder.html#a18">FLAC__file_decoder_get_state</a> (const <a class="el" href="structFLAC____FileDecoder.html">FLAC__FileDecoder</a> *decoder)</td></tr>
54
 
<tr><td nowrap align=right valign=top><a class="el" href="group__flac__seekable__stream__decoder.html#a50">FLAC__SeekableStreamDecoderState</a>&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__decoder.html#a19">FLAC__file_decoder_get_seekable_stream_decoder_state</a> (const <a class="el" href="structFLAC____FileDecoder.html">FLAC__FileDecoder</a> *decoder)</td></tr>
55
 
<tr><td nowrap align=right valign=top><a class="el" href="group__flac__stream__decoder.html#a36">FLAC__StreamDecoderState</a>&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__decoder.html#a20">FLAC__file_decoder_get_stream_decoder_state</a> (const <a class="el" href="structFLAC____FileDecoder.html">FLAC__FileDecoder</a> *decoder)</td></tr>
56
 
<tr><td nowrap align=right valign=top>const char *&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__decoder.html#a21">FLAC__file_decoder_get_resolved_state_string</a> (const <a class="el" href="structFLAC____FileDecoder.html">FLAC__FileDecoder</a> *decoder)</td></tr>
57
 
<tr><td nowrap align=right valign=top>FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__decoder.html#a22">FLAC__file_decoder_get_md5_checking</a> (const <a class="el" href="structFLAC____FileDecoder.html">FLAC__FileDecoder</a> *decoder)</td></tr>
58
 
<tr><td nowrap align=right valign=top>unsigned&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__decoder.html#a23">FLAC__file_decoder_get_channels</a> (const <a class="el" href="structFLAC____FileDecoder.html">FLAC__FileDecoder</a> *decoder)</td></tr>
59
 
<tr><td nowrap align=right valign=top><a class="el" href="group__flac__format.html#a95">FLAC__ChannelAssignment</a>&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__decoder.html#a24">FLAC__file_decoder_get_channel_assignment</a> (const <a class="el" href="structFLAC____FileDecoder.html">FLAC__FileDecoder</a> *decoder)</td></tr>
60
 
<tr><td nowrap align=right valign=top>unsigned&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__decoder.html#a25">FLAC__file_decoder_get_bits_per_sample</a> (const <a class="el" href="structFLAC____FileDecoder.html">FLAC__FileDecoder</a> *decoder)</td></tr>
61
 
<tr><td nowrap align=right valign=top>unsigned&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__decoder.html#a26">FLAC__file_decoder_get_sample_rate</a> (const <a class="el" href="structFLAC____FileDecoder.html">FLAC__FileDecoder</a> *decoder)</td></tr>
62
 
<tr><td nowrap align=right valign=top>unsigned&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__decoder.html#a27">FLAC__file_decoder_get_blocksize</a> (const <a class="el" href="structFLAC____FileDecoder.html">FLAC__FileDecoder</a> *decoder)</td></tr>
63
 
<tr><td nowrap align=right valign=top>FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__decoder.html#a28">FLAC__file_decoder_get_decode_position</a> (const <a class="el" href="structFLAC____FileDecoder.html">FLAC__FileDecoder</a> *decoder, FLAC__uint64 *position)</td></tr>
64
 
<tr><td nowrap align=right valign=top><a class="el" href="group__flac__file__decoder.html#a36">FLAC__FileDecoderState</a>&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__decoder.html#a29">FLAC__file_decoder_init</a> (<a class="el" href="structFLAC____FileDecoder.html">FLAC__FileDecoder</a> *decoder)</td></tr>
65
 
<tr><td nowrap align=right valign=top>FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__decoder.html#a30">FLAC__file_decoder_finish</a> (<a class="el" href="structFLAC____FileDecoder.html">FLAC__FileDecoder</a> *decoder)</td></tr>
66
 
<tr><td nowrap align=right valign=top>FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__decoder.html#a31">FLAC__file_decoder_process_single</a> (<a class="el" href="structFLAC____FileDecoder.html">FLAC__FileDecoder</a> *decoder)</td></tr>
67
 
<tr><td nowrap align=right valign=top>FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__decoder.html#a32">FLAC__file_decoder_process_until_end_of_metadata</a> (<a class="el" href="structFLAC____FileDecoder.html">FLAC__FileDecoder</a> *decoder)</td></tr>
68
 
<tr><td nowrap align=right valign=top>FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__decoder.html#a33">FLAC__file_decoder_process_until_end_of_file</a> (<a class="el" href="structFLAC____FileDecoder.html">FLAC__FileDecoder</a> *decoder)</td></tr>
69
 
<tr><td nowrap align=right valign=top>FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__decoder.html#a34">FLAC__file_decoder_skip_single_frame</a> (<a class="el" href="structFLAC____FileDecoder.html">FLAC__FileDecoder</a> *decoder)</td></tr>
70
 
<tr><td nowrap align=right valign=top>FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__decoder.html#a35">FLAC__file_decoder_seek_absolute</a> (<a class="el" href="structFLAC____FileDecoder.html">FLAC__FileDecoder</a> *decoder, FLAC__uint64 sample)</td></tr>
71
 
<tr><td colspan=2><br><h2>Variables</h2></td></tr>
72
 
<tr><td nowrap align=right valign=top>const char *const&nbsp;</td><td valign=bottom><a class="el" href="group__flac__file__decoder.html#a0">FLAC__FileDecoderStateString</a> []</td></tr>
73
 
</table>
74
 
<hr><a name="_details"></a><h2>Detailed Description</h2>
75
 
This module contains the functions which implement the file decoder.
76
 
<p>
77
 
 
78
 
<p>
79
 
 
80
 
<p>
81
 
 See the detailed documentation in the <a class="el" href="group__flac__file__decoder.html">file decoder</a> module.
82
 
<p>
83
 
<hr><address><small>Generated on Fri Feb 4 18:39:11 2005 for FLAC by
84
 
<a href="http://www.doxygen.org/index.html">
85
 
<img src="doxygen.gif" alt="doxygen" align="middle" border=0 
86
 
width=110 height=53></a>1.2.14 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>,
87
 
 &copy;&nbsp;1997-2002</small></address>
88
 
</body>
89
 
</html>