1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 2<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> 3<title>FLAC: include/FLAC++/decoder.h Source File</title> 4<link href="doxygen.css" rel="stylesheet" type="text/css"> 5</head><body> 6<!-- Generated by Doxygen 1.4.2 --> 7<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a></div> 8<div class="nav"> 9<a class="el" href="dir_000000.html">include</a> / <a class="el" href="dir_000001.html">FLAC++</a></div> 10<h1>decoder.h</h1><a href="decoder_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment">00001 <span class="comment">/* libFLAC++ - Free Lossless Audio Codec library</span> 1100002 <span class="comment"> * Copyright (C) 2002,2003,2004,2005,2006,2007 Josh Coalson</span> 1200003 <span class="comment"> *</span> 1300004 <span class="comment"> * Redistribution and use in source and binary forms, with or without</span> 1400005 <span class="comment"> * modification, are permitted provided that the following conditions</span> 1500006 <span class="comment"> * are met:</span> 1600007 <span class="comment"> *</span> 1700008 <span class="comment"> * - Redistributions of source code must retain the above copyright</span> 1800009 <span class="comment"> * notice, this list of conditions and the following disclaimer.</span> 1900010 <span class="comment"> *</span> 2000011 <span class="comment"> * - Redistributions in binary form must reproduce the above copyright</span> 2100012 <span class="comment"> * notice, this list of conditions and the following disclaimer in the</span> 2200013 <span class="comment"> * documentation and/or other materials provided with the distribution.</span> 2300014 <span class="comment"> *</span> 2400015 <span class="comment"> * - Neither the name of the Xiph.org Foundation nor the names of its</span> 2500016 <span class="comment"> * contributors may be used to endorse or promote products derived from</span> 2600017 <span class="comment"> * this software without specific prior written permission.</span> 2700018 <span class="comment"> *</span> 2800019 <span class="comment"> * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS</span> 2900020 <span class="comment"> * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT</span> 3000021 <span class="comment"> * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR</span> 3100022 <span class="comment"> * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR</span> 3200023 <span class="comment"> * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,</span> 3300024 <span class="comment"> * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,</span> 3400025 <span class="comment"> * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR</span> 3500026 <span class="comment"> * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF</span> 3600027 <span class="comment"> * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING</span> 3700028 <span class="comment"> * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS</span> 3800029 <span class="comment"> * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span> 3900030 <span class="comment"> */</span> 4000031 4100032 <span class="preprocessor">#ifndef FLACPP__DECODER_H</span> 4200033 <span class="preprocessor"></span><span class="preprocessor">#define FLACPP__DECODER_H</span> 4300034 <span class="preprocessor"></span> 4400035 <span class="preprocessor">#include "<a class="code" href="+_2export_8h.html">export.h</a>"</span> 4500036 4600037 <span class="preprocessor">#include <string></span> 4700038 <span class="preprocessor">#include "<a class="code" href="stream__decoder_8h.html">FLAC/stream_decoder.h</a>"</span> 4800039 4900040 5000077 <span class="keyword">namespace </span>FLAC { 5100078 <span class="keyword">namespace </span>Decoder { 5200079 53<a name="l00099"></a><a class="code" href="classFLAC_1_1Decoder_1_1Stream.html">00099</a> <span class="keyword">class </span>FLACPP_API Stream { 5400100 <span class="keyword">public</span>: 55<a name="l00103"></a><a class="code" href="classFLAC_1_1Decoder_1_1Stream_1_1State.html">00103</a> <span class="keyword">class </span>FLACPP_API State { 5600104 <span class="keyword">public</span>: 5700105 <span class="keyword">inline</span> State(::<a class="code" href="group__flac__stream__decoder.html#ga50">FLAC__StreamDecoderState</a> state): state_(state) { } 5800106 <span class="keyword">inline</span> <a class="code" href="group__flac__stream__decoder.html#ga50">operator ::FLAC__StreamDecoderState</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> state_; } 5900107 <span class="keyword">inline</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *as_cstring()<span class="keyword"> const </span>{ <a class="code" href="group__flac__stream__decoder.html#ga0">return ::FLAC__StreamDecoderStateString</a>[state_]; } 6000108 <span class="keyword">inline</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *resolved_as_cstring(<span class="keyword">const</span> Stream &decoder)<span class="keyword"> const </span>{ <a class="code" href="group__flac__stream__decoder.html#ga27">return ::FLAC__stream_decoder_get_resolved_state_string</a>(decoder.<a class="code" href="classFLAC_1_1Decoder_1_1Stream.html#FLAC_1_1Decoder_1_1Streamp0">decoder_</a>); } 6100109 <span class="keyword">protected</span>:<a class="code" href="group__flac__stream__decoder.html#ga50"></a> 6200110 <a class="code" href="group__flac__stream__decoder.html#ga50"> ::FLAC__StreamDecoderState</a> state_; 6300111 }; 6400112 6500113 Stream(); 6600114 <span class="keyword">virtual</span> ~Stream(); 6700115 6800117 6900120 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> is_valid() <span class="keyword">const</span>; 70<a name="l00121"></a><a class="code" href="classFLAC_1_1Decoder_1_1Stream.html#FLAC_1_1Decoder_1_1Streama3">00121</a> <span class="keyword">inline</span> operator bool()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> is_valid(); } 7100122 7200123 7300124 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> set_ogg_serial_number(<span class="keywordtype">long</span> value); 7400125 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> set_md5_checking(<span class="keywordtype">bool</span> value); 7500126 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> set_metadata_respond(::<a class="code" href="group__flac__format.html#ga113">FLAC__MetadataType</a> type); 7600127 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> set_metadata_respond_application(<span class="keyword">const</span> FLAC__byte <span class="keywordtype">id</span>[4]); 7700128 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> set_metadata_respond_all(); 7800129 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> set_metadata_ignore(::<a class="code" href="group__flac__format.html#ga113">FLAC__MetadataType</a> type); 7900130 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> set_metadata_ignore_application(<span class="keyword">const</span> FLAC__byte <span class="keywordtype">id</span>[4]); 8000131 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> set_metadata_ignore_all(); 8100132 8200133 <span class="comment">/* get_state() is not virtual since we want subclasses to be able to return their own state */</span> 8300134 State get_state() <span class="keyword">const</span>; 8400135 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> get_md5_checking() <span class="keyword">const</span>; 8500136 <span class="keyword">virtual</span> FLAC__uint64 get_total_samples() <span class="keyword">const</span>; 8600137 <span class="keyword">virtual</span> <span class="keywordtype">unsigned</span> get_channels() <span class="keyword">const</span>; 8700138 <a class="code" href="group__flac__format.html#ga111">virtual ::FLAC__ChannelAssignment</a> get_channel_assignment() <span class="keyword">const</span>; 8800139 <span class="keyword">virtual</span> <span class="keywordtype">unsigned</span> get_bits_per_sample() <span class="keyword">const</span>; 8900140 <span class="keyword">virtual</span> <span class="keywordtype">unsigned</span> get_sample_rate() <span class="keyword">const</span>; 9000141 <span class="keyword">virtual</span> <span class="keywordtype">unsigned</span> get_blocksize() <span class="keyword">const</span>; 9100142 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> get_decode_position(FLAC__uint64 *position) <span class="keyword">const</span>; 9200143 9300144 <a class="code" href="group__flac__stream__decoder.html#ga51">virtual ::FLAC__StreamDecoderInitStatus</a> init(); 9400145 <a class="code" href="group__flac__stream__decoder.html#ga51">virtual ::FLAC__StreamDecoderInitStatus</a> init_ogg(); 9500146 9600147 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> finish(); 9700148 9800149 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> flush(); 9900150 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> reset(); 10000151 10100152 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> process_single(); 10200153 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> process_until_end_of_metadata(); 10300154 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> process_until_end_of_stream(); 10400155 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> skip_single_frame(); 10500156 10600157 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> seek_absolute(FLAC__uint64 sample); 10700158 <span class="keyword">protected</span>: 10800160 <a class="code" href="group__flac__stream__decoder.html#ga52">virtual ::FLAC__StreamDecoderReadStatus</a> read_callback(FLAC__byte buffer[], size_t *bytes) = 0; 10900161 11000163 <a class="code" href="group__flac__stream__decoder.html#ga53">virtual ::FLAC__StreamDecoderSeekStatus</a> seek_callback(FLAC__uint64 absolute_byte_offset); 11100164 11200166 <a class="code" href="group__flac__stream__decoder.html#ga54">virtual ::FLAC__StreamDecoderTellStatus</a> tell_callback(FLAC__uint64 *absolute_byte_offset); 11300167 11400169 <a class="code" href="group__flac__stream__decoder.html#ga55">virtual ::FLAC__StreamDecoderLengthStatus</a> length_callback(FLAC__uint64 *stream_length); 11500170 11600172 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> eof_callback(); 11700173 11800175 <a class="code" href="group__flac__stream__decoder.html#ga56">virtual ::FLAC__StreamDecoderWriteStatus</a> write_callback(<span class="keyword">const</span> ::<a class="code" href="structFLAC____Frame.html">FLAC__Frame</a> *frame, <span class="keyword">const</span> FLAC__int32 * <span class="keyword">const</span> buffer[]) = 0; 11900176 12000178 <span class="keyword">virtual</span> <span class="keywordtype">void</span> metadata_callback(<span class="keyword">const</span> ::<a class="code" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> *metadata); 12100179 12200181 <span class="keyword">virtual</span> <span class="keywordtype">void</span> error_callback(::<a class="code" href="group__flac__stream__decoder.html#ga57">FLAC__StreamDecoderErrorStatus</a> status) = 0; 12300182 12400183 <span class="preprocessor">#if (defined _MSC_VER) || (defined __BORLANDC__) || (defined __GNUG__ && (__GNUG__ < 2 || (__GNUG__ == 2 && __GNUC_MINOR__ < 96))) || (defined __SUNPRO_CC)</span> 12500184 <span class="preprocessor"></span> <span class="comment">// lame hack: some MSVC/GCC versions can't see a protected decoder_ from nested State::resolved_as_cstring()</span> 12600185 <span class="keyword">friend</span> State; 12700186 <span class="preprocessor">#endif</span> 12800187 <span class="preprocessor"></span> ::FLAC__StreamDecoder *decoder_; 12900188 13000189 <a class="code" href="group__flac__stream__decoder.html#ga52">static ::FLAC__StreamDecoderReadStatus</a> read_callback_(<span class="keyword">const</span> ::<a class="code" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> *decoder, FLAC__byte buffer[], size_t *bytes, <span class="keywordtype">void</span> *client_data); 13100190 <a class="code" href="group__flac__stream__decoder.html#ga53">static ::FLAC__StreamDecoderSeekStatus</a> seek_callback_(<span class="keyword">const</span> ::<a class="code" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> *decoder, FLAC__uint64 absolute_byte_offset, <span class="keywordtype">void</span> *client_data); 13200191 <a class="code" href="group__flac__stream__decoder.html#ga54">static ::FLAC__StreamDecoderTellStatus</a> tell_callback_(<span class="keyword">const</span> ::<a class="code" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> *decoder, FLAC__uint64 *absolute_byte_offset, <span class="keywordtype">void</span> *client_data); 13300192 <a class="code" href="group__flac__stream__decoder.html#ga55">static ::FLAC__StreamDecoderLengthStatus</a> length_callback_(<span class="keyword">const</span> ::<a class="code" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> *decoder, FLAC__uint64 *stream_length, <span class="keywordtype">void</span> *client_data); 13400193 <span class="keyword">static</span> FLAC__bool eof_callback_(<span class="keyword">const</span> ::<a class="code" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> *decoder, <span class="keywordtype">void</span> *client_data); 13500194 <a class="code" href="group__flac__stream__decoder.html#ga56">static ::FLAC__StreamDecoderWriteStatus</a> write_callback_(<span class="keyword">const</span> ::<a class="code" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> *decoder, <span class="keyword">const</span> ::<a class="code" href="structFLAC____Frame.html">FLAC__Frame</a> *frame, <span class="keyword">const</span> FLAC__int32 * <span class="keyword">const</span> buffer[], <span class="keywordtype">void</span> *client_data); 13600195 <span class="keyword">static</span> <span class="keywordtype">void</span> metadata_callback_(<span class="keyword">const</span> ::<a class="code" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> *decoder, <span class="keyword">const</span> ::<a class="code" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> *metadata, <span class="keywordtype">void</span> *client_data); 13700196 <span class="keyword">static</span> <span class="keywordtype">void</span> error_callback_(<span class="keyword">const</span> ::<a class="code" href="structFLAC____StreamDecoder.html">FLAC__StreamDecoder</a> *decoder, ::<a class="code" href="group__flac__stream__decoder.html#ga57">FLAC__StreamDecoderErrorStatus</a> status, <span class="keywordtype">void</span> *client_data); 13800197 <span class="keyword">private</span>: 13900198 <span class="comment">// Private and undefined so you can't use them:</span> 14000199 Stream(<span class="keyword">const</span> Stream &); 14100200 <span class="keywordtype">void</span> operator=(<span class="keyword">const</span> Stream &); 14200201 }; 14300202 144<a name="l00222"></a><a class="code" href="classFLAC_1_1Decoder_1_1File.html">00222</a> <span class="keyword">class </span>FLACPP_API File: <span class="keyword">public</span> Stream { 14500223 <span class="keyword">public</span>: 14600224 File(); 14700225 <span class="keyword">virtual</span> ~File(); 14800226 14900227 <a class="code" href="group__flac__stream__decoder.html#ga51">virtual ::FLAC__StreamDecoderInitStatus</a> init(FILE *file); 15000228 <a class="code" href="group__flac__stream__decoder.html#ga51">virtual ::FLAC__StreamDecoderInitStatus</a> init(<span class="keyword">const</span> <span class="keywordtype">char</span> *filename); 15100229 <a class="code" href="group__flac__stream__decoder.html#ga51">virtual ::FLAC__StreamDecoderInitStatus</a> init(<span class="keyword">const</span> std::string &filename); 15200230 <a class="code" href="group__flac__stream__decoder.html#ga51">virtual ::FLAC__StreamDecoderInitStatus</a> init_ogg(FILE *file); 15300231 <a class="code" href="group__flac__stream__decoder.html#ga51">virtual ::FLAC__StreamDecoderInitStatus</a> init_ogg(<span class="keyword">const</span> <span class="keywordtype">char</span> *filename); 15400232 <a class="code" href="group__flac__stream__decoder.html#ga51">virtual ::FLAC__StreamDecoderInitStatus</a> init_ogg(<span class="keyword">const</span> std::string &filename); 15500233 <span class="keyword">protected</span>: 15600234 <span class="comment">// this is a dummy implementation to satisfy the pure virtual in Stream that is actually supplied internally by the C layer</span> 15700235 <a class="code" href="group__flac__stream__decoder.html#ga52">virtual ::FLAC__StreamDecoderReadStatus</a> read_callback(FLAC__byte buffer[], size_t *bytes); 15800236 <span class="keyword">private</span>: 15900237 <span class="comment">// Private and undefined so you can't use them:</span> 16000238 File(<span class="keyword">const</span> File &); 16100239 <span class="keywordtype">void</span> operator=(<span class="keyword">const</span> File &); 16200240 }; 16300241 16400242 } 16500243 } 16600244 16700245 <span class="preprocessor">#endif</span> 168</pre></div> 169<hr size="1"> 170<div class="copyright"> 171 <!-- @@@ oh so hacky --> 172 <table> 173 <tr> 174 <td align="left"> 175 Copyright (c) 2000,2001,2002,2003,2004,2005,2006,2007 Josh Coalson 176 </td> 177 <td width="1%" align="right"> 178 <a href="http://sourceforge.net"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=13478&type=1" width="88" height="31" border="0" alt="SourceForge.net Logo" /></a> 179 </td> 180 </tr> 181 </table> 182</div> 183<!-- Copyright (c) 2000,2001,2002,2003,2004,2005,2006,2007 Josh Coalson --> 184<!-- Permission is granted to copy, distribute and/or modify this document --> 185<!-- under the terms of the GNU Free Documentation License, Version 1.1 --> 186<!-- or any later version published by the Free Software Foundation; --> 187<!-- with no invariant sections. --> 188<!-- A copy of the license can be found at http://www.gnu.org/copyleft/fdl.html --> 189</body> 190</html> 191