1
0
mirror of https://github.com/cookiengineer/audacity synced 2025-06-27 17:48:38 +02:00
audacity/lib-src/libflac/doc/html/api/group__flacpp__decoder.html
2015-05-01 03:33:07 -05:00

87 lines
5.6 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.8"/>
<title>FLAC: FLAC++/decoder.h: decoder classes</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">FLAC
&#160;<span id="projectnumber">1.3.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.8 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> </div>
<div class="headertitle">
<div class="title">FLAC++/decoder.h: decoder classes<div class="ingroups"><a class="el" href="group__flacpp.html">FLAC C++ API</a></div></div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFLAC_1_1Decoder_1_1Stream.html">FLAC::Decoder::Stream</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFLAC_1_1Decoder_1_1Stream_1_1State.html">FLAC::Decoder::Stream::State</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFLAC_1_1Decoder_1_1File.html">FLAC::Decoder::File</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>This module describes the decoder layers provided by libFLAC++. </p>
<p>The libFLAC++ decoder classes are object wrappers around their counterparts in libFLAC. All decoding layers available in libFLAC are also provided here. The interface is very similar; make sure to read the <a class="el" href="group__flac__decoder.html">libFLAC decoder module </a>.</p>
<p>There are only two significant differences here. First, instead of passing in C function pointers for callbacks, you inherit from the decoder class and provide implementations for the callbacks in your derived class; because of this there is no need for a 'client_data' property.</p>
<p>Second, there are two stream decoder classes. <a class="el" href="classFLAC_1_1Decoder_1_1Stream.html" title="This class wraps the FLAC__StreamDecoder. If you are decoding from a file, FLAC::Decoder::File may be...">FLAC::Decoder::Stream</a> is used for the same cases that <a class="el" href="group__flac__stream__decoder.html#ga150d381abc5249168e439bc076544b29">FLAC__stream_decoder_init_stream()</a> / <a class="el" href="group__flac__stream__decoder.html#ga1b043adeb805c779c1e97cb68959d1ab">FLAC__stream_decoder_init_ogg_stream()</a> are used, and <a class="el" href="classFLAC_1_1Decoder_1_1File.html" title="This class wraps the FLAC__StreamDecoder. If you are not decoding from a file, you may need to use FL...">FLAC::Decoder::File</a> is used for the same cases that <a class="el" href="group__flac__stream__decoder.html#ga80aa83631460a53263c84e654586dff0">FLAC__stream_decoder_init_FILE()</a> and <a class="el" href="group__flac__stream__decoder.html#ga4021ead5cff29fd589c915756f902f1a">FLAC__stream_decoder_init_file()</a> / <a class="el" href="group__flac__stream__decoder.html#ga4cc7fbaf905c24d6db48b53b7942fe72">FLAC__stream_decoder_init_ogg_FILE()</a> and <a class="el" href="group__flac__stream__decoder.html#ga548f15d7724f3bff7f2608abe8b12f6c">FLAC__stream_decoder_init_ogg_file()</a> are used. </p>
</div><!-- contents -->
<hr size="1">
<div class="copyright">
<!-- @@@ oh so hacky -->
<table>
<tr>
<td align="left">
Copyright (c) 2000-2009 Josh Coalson
Copyright (c) 2011-2014 Xiph.Org Foundation
</td>
<td width="1%" align="right">
<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>
</td>
</tr>
</table>
</div>
<!-- Copyright (c) 2000-2009 Josh Coalson -->
<!-- Copyright (c) 2011-2014 Xiph.Org Foundation -->
<!-- Permission is granted to copy, distribute and/or modify this document -->
<!-- under the terms of the GNU Free Documentation License, Version 1.1 -->
<!-- or any later version published by the Free Software Foundation; -->
<!-- with no invariant sections. -->
<!-- A copy of the license can be found at http://www.gnu.org/copyleft/fdl.html -->
</body>
</html>