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

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Joshua Kwan
  • Date: 2007-05-29 22:56:36 UTC
  • mto: (8.1.1 lenny)
  • mto: This revision was merged to the branch mainline in revision 9.
  • Revision ID: james.westby@ubuntu.com-20070529225636-p8lkii0r0kp50pns
Tags: upstream-1.1.4
ImportĀ upstreamĀ versionĀ 1.1.4

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
 
1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
2
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
3
 
<title>FLAC/_decoder.h: decoder interfaces</title>
 
3
<title>FLAC: FLAC/_decoder.h: decoder interfaces</title>
4
4
<link href="doxygen.css" rel="stylesheet" type="text/css">
5
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>FLAC/_decoder.h: decoder interfaces<br>
 
6
<!-- Generated by Doxygen 1.4.2 -->
 
7
<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a></div>
 
8
<h1>FLAC/_decoder.h: decoder interfaces<br>
10
9
<small>
11
10
[<a class="el" href="group__flac.html">FLAC C API</a>]</small>
12
 
</h1>This module describes the three decoder layers provided by libFLAC. 
13
 
<a href="#_details">More...</a><table border=0 cellpadding=0 cellspacing=0>
14
 
<tr><td colspan=2><br><h2>Modules</h2></td></tr>
15
 
<tr><td nowrap align=right valign=top><a class="el" href="group__flac__file__decoder.html">FLAC/file_decoder.h: file decoder interface</a></td></tr>
16
 
<tr><td>&nbsp;</td><td><font size=-1><em>This module contains the functions which implement the file decoder.</em></font><br><br></td></tr>
17
 
 
18
 
<p>
19
 
<tr><td nowrap align=right valign=top><a class="el" href="group__flac__seekable__stream__decoder.html">FLAC/seekable_stream_decoder.h: seekable stream decoder interface</a></td></tr>
20
 
<tr><td>&nbsp;</td><td><font size=-1><em>This module contains the functions which implement the seekable stream decoder.</em></font><br><br></td></tr>
21
 
 
22
 
<p>
23
 
<tr><td nowrap align=right valign=top><a class="el" href="group__flac__stream__decoder.html">FLAC/stream_decoder.h: stream decoder interface</a></td></tr>
24
 
<tr><td>&nbsp;</td><td><font size=-1><em>This module contains the functions which implement the stream decoder.</em></font><br><br></td></tr>
25
 
 
26
 
<p>
 
11
</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
 
12
This module describes the decoder layers provided by libFLAC. 
 
13
<p>
 
14
The stream decoder can be used to decode complete streams either from the client via callbacks, or directly from a file, depending on how it is initialized. When decoding via callbacks, the client provides callbacks for reading FLAC data and writing decoded samples, and handling metadata and errors. If the client also supplies seek-related callback, the decoder function for sample-accurate seeking within the FLAC input is also available. When decoding from a file, the client needs only supply a filename or open <code>FILE*</code> and write/metadata/error callbacks; the rest of the callbacks are supplied internally. For more info see the <a class="el" href="group__flac__stream__decoder.html">stream decoder </a> module. 
 
15
<p>
 
16
<table border="0" cellpadding="0" cellspacing="0">
 
17
<tr><td></td></tr>
 
18
<tr><td colspan="2"><br><h2>Modules</h2></td></tr>
 
19
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__stream__decoder.html">FLAC/stream_decoder.h: stream decoder interface</a></td></tr>
 
20
 
27
21
</table>
28
 
<hr><a name="_details"></a><h2>Detailed Description</h2>
29
 
This module describes the three decoder layers provided by libFLAC.
30
 
<p>
31
22
 
32
 
<p>
33
 
 For decoding FLAC streams, libFLAC provides three layers of access. The lowest layer is non-seekable stream-level decoding, the next is seekable stream-level decoding, and the highest layer is file-level decoding. The interfaces are described in the <a class="el" href="group__flac__stream__decoder.html">stream decoder</a>, <a class="el" href="group__flac__seekable__stream__decoder.html">seekable stream decoder</a>, and <a class="el" href="group__flac__file__decoder.html">file decoder</a> modules respectively. Typically you will choose the highest layer that your input source will support.
34
 
<p>
35
 
The stream decoder relies on callbacks for all input and output and has no provisions for seeking. The seekable stream decoder wraps the stream decoder and exposes functions for seeking. However, you must provide extra callbacks for seek-related operations on your stream, like seek and tell. The file decoder wraps the seekable stream decoder and supplies most of the callbacks internally, simplifying the processing of standard files. <hr><address><small>Generated on Fri Feb 4 18:39:17 2005 for FLAC by
36
 
<a href="http://www.doxygen.org/index.html">
37
 
<img src="doxygen.gif" alt="doxygen" align="middle" border=0 
38
 
width=110 height=53></a>1.2.14 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>,
39
 
 &copy;&nbsp;1997-2002</small></address>
 
23
<hr size="1">
 
24
<div class="copyright">
 
25
        <!-- @@@ oh so hacky -->
 
26
        <table>
 
27
                <tr>
 
28
                        <td align="left">
 
29
                                Copyright (c) 2000,2001,2002,2003,2004,2005,2006,2007  Josh Coalson
 
30
                        </td>
 
31
                        <td width="1%" align="right">
 
32
                                <a href="http://sourceforge.net"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=13478&amp;type=1" width="88" height="31" border="0" alt="SourceForge.net Logo" /></a>
 
33
                        </td>
 
34
                </tr>
 
35
        </table>
 
36
</div>
 
37
<!-- Copyright (c)  2000,2001,2002,2003,2004,2005,2006,2007  Josh Coalson -->
 
38
<!-- Permission is granted to copy, distribute and/or modify this document -->
 
39
<!-- under the terms of the GNU Free Documentation License, Version 1.1 -->
 
40
<!-- or any later version published by the Free Software Foundation; -->
 
41
<!-- with no invariant sections. -->
 
42
<!-- A copy of the license can be found at http://www.gnu.org/copyleft/fdl.html -->
40
43
</body>
41
44
</html>