← Back to branch summary

~ubuntu-branches/ubuntu/utopic/flac/utopic-security

« back to all changes in this revision

Viewing changes to doc/html/api/decoder_8h-source.html

  • Committer: Package Import Robot
  • Author(s): Fabian Greffrath
  • Date: 2013-06-07 10:24:30 UTC
  • mfrom: (1.1.6)
  • Revision ID: package-import@ubuntu.com-20130607102430-x7e7zt462c0tuetp
Tags: 1.3.0-1
http://bugs.debian.org/527542
http://bugs.debian.org/705601
http://bugs.debian.org/710062
* Imported Upstream version 1.3.0 (Closes: #527542, #705601).
* Update debian/watch file, thanks Ulrich Klauer (Closes: #710062).
* Revert "Remove manpages from master branch."
* Imported Upstream version 1.3.0
* Convert package to "3.0 (quilt)" source format.
* Remove all patches, they have either been merged upstream or do not
  apply anymore (tested).
* Explicitly enable static libraries.
* Simplify debian/libflac-doc.install.
* Bump shlibs for added symbols.
* Remove needless Build-Depends: libid3-3.8.3-dev.
* Update Homepage field.
* Repair upstream manpage regeneration rule.
* Bump Build-Depends: debhelper (>= 9).
* Fix vcs-field-not-canonical.
* Import two patches from upstream GIT:
  + Add missing config.h includes.
  + Fix local_strcat() to terminate string correctly.
* Disable 3DNow! optimizations, enable SSE only on amd64, enable Altivec
  only on ppc64, disable ASM optimizations elsewhere.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/html/api/decoder_8h-source.html
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&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
 
<div class="nav">
9
 
<a class="el" href="dir_000000.html">include</a>&nbsp;/&nbsp;<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>
11
 
00002 <span class="comment"> * Copyright (C) 2002,2003,2004,2005,2006,2007  Josh Coalson</span>
12
 
00003 <span class="comment"> *</span>
13
 
00004 <span class="comment"> * Redistribution and use in source and binary forms, with or without</span>
14
 
00005 <span class="comment"> * modification, are permitted provided that the following conditions</span>
15
 
00006 <span class="comment"> * are met:</span>
16
 
00007 <span class="comment"> *</span>
17
 
00008 <span class="comment"> * - Redistributions of source code must retain the above copyright</span>
18
 
00009 <span class="comment"> * notice, this list of conditions and the following disclaimer.</span>
19
 
00010 <span class="comment"> *</span>
20
 
00011 <span class="comment"> * - Redistributions in binary form must reproduce the above copyright</span>
21
 
00012 <span class="comment"> * notice, this list of conditions and the following disclaimer in the</span>
22
 
00013 <span class="comment"> * documentation and/or other materials provided with the distribution.</span>
23
 
00014 <span class="comment"> *</span>
24
 
00015 <span class="comment"> * - Neither the name of the Xiph.org Foundation nor the names of its</span>
25
 
00016 <span class="comment"> * contributors may be used to endorse or promote products derived from</span>
26
 
00017 <span class="comment"> * this software without specific prior written permission.</span>
27
 
00018 <span class="comment"> *</span>
28
 
00019 <span class="comment"> * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS</span>
29
 
00020 <span class="comment"> * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT</span>
30
 
00021 <span class="comment"> * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR</span>
31
 
00022 <span class="comment"> * A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR</span>
32
 
00023 <span class="comment"> * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,</span>
33
 
00024 <span class="comment"> * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,</span>
34
 
00025 <span class="comment"> * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR</span>
35
 
00026 <span class="comment"> * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF</span>
36
 
00027 <span class="comment"> * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING</span>
37
 
00028 <span class="comment"> * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS</span>
38
 
00029 <span class="comment"> * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span>
39
 
00030 <span class="comment"> */</span>
40
 
00031 
41
 
00032 <span class="preprocessor">#ifndef FLACPP__DECODER_H</span>
42
 
00033 <span class="preprocessor"></span><span class="preprocessor">#define FLACPP__DECODER_H</span>
43
 
00034 <span class="preprocessor"></span>
44
 
00035 <span class="preprocessor">#include "<a class="code" href="+_2export_8h.html">export.h</a>"</span>
45
 
00036 
46
 
00037 <span class="preprocessor">#include &lt;string&gt;</span>
47
 
00038 <span class="preprocessor">#include "<a class="code" href="stream__decoder_8h.html">FLAC/stream_decoder.h</a>"</span>
48
 
00039 
49
 
00040 
50
 
00077 <span class="keyword">namespace </span>FLAC {
51
 
00078     <span class="keyword">namespace </span>Decoder {
52
 
00079 
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 {
54
 
00100         <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 {
56
 
00104             <span class="keyword">public</span>:
57
 
00105                 <span class="keyword">inline</span> State(::<a class="code" href="group__flac__stream__decoder.html#ga50">FLAC__StreamDecoderState</a> state): state_(state) { }
58
 
00106                 <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_; }
59
 
00107                 <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_]; }
60
 
00108                 <span class="keyword">inline</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *resolved_as_cstring(<span class="keyword">const</span> Stream &amp;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>); }
61
 
00109             <span class="keyword">protected</span>:<a class="code" href="group__flac__stream__decoder.html#ga50"></a>
62
 
00110 <a class="code" href="group__flac__stream__decoder.html#ga50">                            ::FLAC__StreamDecoderState</a> state_;
63
 
00111             };
64
 
00112 
65
 
00113             Stream();
66
 
00114             <span class="keyword">virtual</span> ~Stream();
67
 
00115 
68
 
00117 
69
 
00120             <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(); } 
71
 
00122 
72
 
00123 
73
 
00124             <span class="keyword">virtual</span> <span class="keywordtype">bool</span> set_ogg_serial_number(<span class="keywordtype">long</span> value);                        
74
 
00125             <span class="keyword">virtual</span> <span class="keywordtype">bool</span> set_md5_checking(<span class="keywordtype">bool</span> value);                             
75
 
00126             <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);          
76
 
00127             <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]); 
77
 
00128             <span class="keyword">virtual</span> <span class="keywordtype">bool</span> set_metadata_respond_all();                               
78
 
00129             <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);           
79
 
00130             <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]);  
80
 
00131             <span class="keyword">virtual</span> <span class="keywordtype">bool</span> set_metadata_ignore_all();                                
81
 
00132 
82
 
00133             <span class="comment">/* get_state() is not virtual since we want subclasses to be able to return their own state */</span>
83
 
00134             State get_state() <span class="keyword">const</span>;                                          
84
 
00135             <span class="keyword">virtual</span> <span class="keywordtype">bool</span> get_md5_checking() <span class="keyword">const</span>;                            
85
 
00136             <span class="keyword">virtual</span> FLAC__uint64 get_total_samples() <span class="keyword">const</span>;                   
86
 
00137             <span class="keyword">virtual</span> <span class="keywordtype">unsigned</span> get_channels() <span class="keyword">const</span>;                            
87
 
00138             <a class="code" href="group__flac__format.html#ga111">virtual ::FLAC__ChannelAssignment</a> get_channel_assignment() <span class="keyword">const</span>; 
88
 
00139             <span class="keyword">virtual</span> <span class="keywordtype">unsigned</span> get_bits_per_sample() <span class="keyword">const</span>;                     
89
 
00140             <span class="keyword">virtual</span> <span class="keywordtype">unsigned</span> get_sample_rate() <span class="keyword">const</span>;                         
90
 
00141             <span class="keyword">virtual</span> <span class="keywordtype">unsigned</span> get_blocksize() <span class="keyword">const</span>;                           
91
 
00142             <span class="keyword">virtual</span> <span class="keywordtype">bool</span> get_decode_position(FLAC__uint64 *position) <span class="keyword">const</span>;   
92
 
00143 
93
 
00144             <a class="code" href="group__flac__stream__decoder.html#ga51">virtual ::FLAC__StreamDecoderInitStatus</a> init();      
94
 
00145             <a class="code" href="group__flac__stream__decoder.html#ga51">virtual ::FLAC__StreamDecoderInitStatus</a> init_ogg();  
95
 
00146 
96
 
00147             <span class="keyword">virtual</span> <span class="keywordtype">bool</span> finish(); 
97
 
00148 
98
 
00149             <span class="keyword">virtual</span> <span class="keywordtype">bool</span> flush(); 
99
 
00150             <span class="keyword">virtual</span> <span class="keywordtype">bool</span> reset(); 
100
 
00151 
101
 
00152             <span class="keyword">virtual</span> <span class="keywordtype">bool</span> process_single();                
102
 
00153             <span class="keyword">virtual</span> <span class="keywordtype">bool</span> process_until_end_of_metadata(); 
103
 
00154             <span class="keyword">virtual</span> <span class="keywordtype">bool</span> process_until_end_of_stream();   
104
 
00155             <span class="keyword">virtual</span> <span class="keywordtype">bool</span> skip_single_frame();             
105
 
00156 
106
 
00157             <span class="keyword">virtual</span> <span class="keywordtype">bool</span> seek_absolute(FLAC__uint64 sample); 
107
 
00158         <span class="keyword">protected</span>:
108
 
00160             <a class="code" href="group__flac__stream__decoder.html#ga52">virtual ::FLAC__StreamDecoderReadStatus</a> read_callback(FLAC__byte buffer[], size_t *bytes) = 0;
109
 
00161 
110
 
00163             <a class="code" href="group__flac__stream__decoder.html#ga53">virtual ::FLAC__StreamDecoderSeekStatus</a> seek_callback(FLAC__uint64 absolute_byte_offset);
111
 
00164 
112
 
00166             <a class="code" href="group__flac__stream__decoder.html#ga54">virtual ::FLAC__StreamDecoderTellStatus</a> tell_callback(FLAC__uint64 *absolute_byte_offset);
113
 
00167 
114
 
00169             <a class="code" href="group__flac__stream__decoder.html#ga55">virtual ::FLAC__StreamDecoderLengthStatus</a> length_callback(FLAC__uint64 *stream_length);
115
 
00170 
116
 
00172             <span class="keyword">virtual</span> <span class="keywordtype">bool</span> eof_callback();
117
 
00173 
118
 
00175             <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;
119
 
00176 
120
 
00178             <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);
121
 
00179 
122
 
00181             <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;
123
 
00182 
124
 
00183 <span class="preprocessor">#if (defined _MSC_VER) || (defined __BORLANDC__) || (defined __GNUG__ &amp;&amp; (__GNUG__ &lt; 2 || (__GNUG__ == 2 &amp;&amp; __GNUC_MINOR__ &lt; 96))) || (defined __SUNPRO_CC)</span>
125
 
00184 <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>
126
 
00185             <span class="keyword">friend</span> State;
127
 
00186 <span class="preprocessor">#endif</span>
128
 
00187 <span class="preprocessor"></span>            ::FLAC__StreamDecoder *decoder_;
129
 
00188 
130
 
00189             <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);
131
 
00190             <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);
132
 
00191             <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);
133
 
00192             <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);
134
 
00193             <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);
135
 
00194             <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);
136
 
00195             <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);
137
 
00196             <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);
138
 
00197         <span class="keyword">private</span>:
139
 
00198             <span class="comment">// Private and undefined so you can't use them:</span>
140
 
00199             Stream(<span class="keyword">const</span> Stream &amp;);
141
 
00200             <span class="keywordtype">void</span> operator=(<span class="keyword">const</span> Stream &amp;);
142
 
00201         };
143
 
00202 
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 {
145
 
00223         <span class="keyword">public</span>:
146
 
00224             File();
147
 
00225             <span class="keyword">virtual</span> ~File();
148
 
00226 
149
 
00227             <a class="code" href="group__flac__stream__decoder.html#ga51">virtual ::FLAC__StreamDecoderInitStatus</a> init(FILE *file);                      
150
 
00228             <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);            
151
 
00229             <a class="code" href="group__flac__stream__decoder.html#ga51">virtual ::FLAC__StreamDecoderInitStatus</a> init(<span class="keyword">const</span> std::string &amp;filename);     
152
 
00230             <a class="code" href="group__flac__stream__decoder.html#ga51">virtual ::FLAC__StreamDecoderInitStatus</a> init_ogg(FILE *file);                  
153
 
00231             <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);        
154
 
00232             <a class="code" href="group__flac__stream__decoder.html#ga51">virtual ::FLAC__StreamDecoderInitStatus</a> init_ogg(<span class="keyword">const</span> std::string &amp;filename); 
155
 
00233         <span class="keyword">protected</span>:
156
 
00234             <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>
157
 
00235             <a class="code" href="group__flac__stream__decoder.html#ga52">virtual ::FLAC__StreamDecoderReadStatus</a> read_callback(FLAC__byte buffer[], size_t *bytes);
158
 
00236         <span class="keyword">private</span>:
159
 
00237             <span class="comment">// Private and undefined so you can't use them:</span>
160
 
00238             File(<span class="keyword">const</span> File &amp;);
161
 
00239             <span class="keywordtype">void</span> operator=(<span class="keyword">const</span> File &amp;);
162
 
00240         };
163
 
00241 
164
 
00242     }
165
 
00243 }
166
 
00244 
167
 
00245 <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&amp;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>