~ubuntu-branches/ubuntu/karmic/flac/karmic

<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">Compound List</a>   <a class="qindex" href="files.html">File List</a>   <a class="qindex" href="functions.html">Compound Members</a>   <a class="qindex" href="globals.html">File Members</a>   </center>

<hr><h1>include/FLAC/file_encoder.h</h1><a href="FLAC_2file__encoder_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 /* libFLAC - Free Lossless Audio Codec library

00003 *

00004 * Redistribution and use in source and binary forms, with or without

00005 * modification, are permitted provided that the following conditions

00006 * are met:

00007 *

00008 * - Redistributions of source code must retain the above copyright

00009 * notice, this list of conditions and the following disclaimer.

00010 *

00011 * - Redistributions in binary form must reproduce the above copyright

00012 * notice, this list of conditions and the following disclaimer in the

00013 * documentation and/or other materials provided with the distribution.

00014 *

00015 * - Neither the name of the Xiph.org Foundation nor the names of its

00016 * contributors may be used to endorse or promote products derived from

00017 * this software without specific prior written permission.

00018 *

00019 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS

00020 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT

00021 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR

00022 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR

00023 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,

00024 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,

00025 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR

00026 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF

00027 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING

00028 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS

00029 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

00030 */

00031

00032 #ifndef FLAC__FILE_ENCODER_H

00033 #define FLAC__FILE_ENCODER_H

00034

00035 #include "export.h"

00036 #include "<a class="code" href="OggFLAC_2seekable__stream__encoder_8h.html">seekable_stream_encoder.h</a>"

00037

00038 #ifdef __cplusplus

00039 extern "C" {

00040 #endif

00041

00042

<a name="l00105"></a><a class="code" href="group__flac__file__encoder.html#a52">00105</a> typedef enum {

00106

00107 <a class="code" href="FLAC_2file__encoder_8h.html#a52a2">FLAC__FILE_ENCODER_OK</a> = 0,

00110 <a class="code" href="FLAC_2file__encoder_8h.html#a52a3">FLAC__FILE_ENCODER_NO_FILENAME</a>,

00115 <a class="code" href="FLAC_2file__encoder_8h.html#a52a4">FLAC__FILE_ENCODER_SEEKABLE_STREAM_ENCODER_ERROR</a>,

00120 <a class="code" href="FLAC_2file__encoder_8h.html#a52a5">FLAC__FILE_ENCODER_FATAL_ERROR_WHILE_WRITING</a>,

00123 <a class="code" href="FLAC_2file__encoder_8h.html#a52a6">FLAC__FILE_ENCODER_ERROR_OPENING_FILE</a>,

00126 <a class="code" href="FLAC_2file__encoder_8h.html#a52a7">FLAC__FILE_ENCODER_MEMORY_ALLOCATION_ERROR</a>,

00129 <a class="code" href="FLAC_2file__encoder_8h.html#a52a8">FLAC__FILE_ENCODER_ALREADY_INITIALIZED</a>,

00135 <a class="code" href="FLAC_2file__encoder_8h.html#a52a9">FLAC__FILE_ENCODER_UNINITIALIZED</a>

00138 } <a class="code" href="FLAC_2file__encoder_8h.html#a52">FLAC__FileEncoderState</a>;

00139

<a name="l00145"></a><a class="code" href="group__flac__file__encoder.html#a0">00145</a> extern FLAC_API const char * const <a class="code" href="FLAC_2file__encoder_8h.html#a0">FLAC__FileEncoderStateString</a>[];

00146

00147

00148 /***********************************************************************

00149 *

00150 * class FLAC__FileEncoder

00151 *

00152 ***********************************************************************/

00153

00154 struct FLAC__FileEncoderProtected;

00155 struct FLAC__FileEncoderPrivate;

<a name="l00160"></a><a class="code" href="structFLAC____FileEncoder.html">00160</a> typedef struct {

00161 struct FLAC__FileEncoderProtected *protected_; /* avoid the C++ keyword 'protected' */

00162 struct FLAC__FileEncoderPrivate *private_; /* avoid the C++ keyword 'private' */

00163 } <a class="code" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a>;

00164

<a name="l00177"></a><a class="code" href="group__flac__file__encoder.html#a1">00177</a> typedef void (*<a class="code" href="FLAC_2file__encoder_8h.html#a1">FLAC__FileEncoderProgressCallback</a>)(const <a class="code" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, FLAC__uint64 bytes_written, FLAC__uint64 samples_written, unsigned frames_written, unsigned total_frames_estimate, void *client_data);

00178

00179

00180 /***********************************************************************

00181 *

00182 * Class constructor/destructor

00183 *

00184 ***********************************************************************/

00185

00193 FLAC_API <a class="code" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *<a class="code" href="FLAC_2file__encoder_8h.html#a2">FLAC__file_encoder_new</a>();

00194

00201 FLAC_API void <a class="code" href="FLAC_2file__encoder_8h.html#a3">FLAC__file_encoder_delete</a>(<a class="code" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder);

00202

00203 /***********************************************************************

00204 *

00205 * Public class method prototypes

00206 *

00207 ***********************************************************************/

00208

00220 FLAC_API FLAC__bool <a class="code" href="FLAC_2file__encoder_8h.html#a4">FLAC__file_encoder_set_verify</a>(<a class="code" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, FLAC__bool value);

00221

100

00233 FLAC_API FLAC__bool <a class="code" href="FLAC_2file__encoder_8h.html#a5">FLAC__file_encoder_set_streamable_subset</a>(<a class="code" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, FLAC__bool value);

101

00234

102

00246 FLAC_API FLAC__bool <a class="code" href="FLAC_2file__encoder_8h.html#a6">FLAC__file_encoder_set_do_mid_side_stereo</a>(<a class="code" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, FLAC__bool value);

103

00247

104

00259 FLAC_API FLAC__bool <a class="code" href="FLAC_2file__encoder_8h.html#a7">FLAC__file_encoder_set_loose_mid_side_stereo</a>(<a class="code" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, FLAC__bool value);

105

00260

106

00272 FLAC_API FLAC__bool <a class="code" href="FLAC_2file__encoder_8h.html#a8">FLAC__file_encoder_set_channels</a>(<a class="code" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, unsigned value);

107

00273

108

00289 FLAC_API FLAC__bool <a class="code" href="FLAC_2file__encoder_8h.html#a9">FLAC__file_encoder_set_bits_per_sample</a>(<a class="code" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, unsigned value);

109

00290

110

00302 FLAC_API FLAC__bool <a class="code" href="FLAC_2file__encoder_8h.html#a10">FLAC__file_encoder_set_sample_rate</a>(<a class="code" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, unsigned value);

111

00303

112

00315 FLAC_API FLAC__bool <a class="code" href="FLAC_2file__encoder_8h.html#a11">FLAC__file_encoder_set_blocksize</a>(<a class="code" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, unsigned value);

113

00316

114

00328 FLAC_API FLAC__bool <a class="code" href="FLAC_2file__encoder_8h.html#a12">FLAC__file_encoder_set_max_lpc_order</a>(<a class="code" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, unsigned value);

115

00329

116

00345 FLAC_API FLAC__bool <a class="code" href="FLAC_2file__encoder_8h.html#a13">FLAC__file_encoder_set_qlp_coeff_precision</a>(<a class="code" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, unsigned value);

117

00346

118

00358 FLAC_API FLAC__bool <a class="code" href="FLAC_2file__encoder_8h.html#a14">FLAC__file_encoder_set_do_qlp_coeff_prec_search</a>(<a class="code" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, FLAC__bool value);

119

00359

120

00371 FLAC_API FLAC__bool <a class="code" href="FLAC_2file__encoder_8h.html#a15">FLAC__file_encoder_set_do_escape_coding</a>(<a class="code" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, FLAC__bool value);

121

00372

122

00384 FLAC_API FLAC__bool <a class="code" href="FLAC_2file__encoder_8h.html#a16">FLAC__file_encoder_set_do_exhaustive_model_search</a>(<a class="code" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, FLAC__bool value);

123

00385

124

00397 FLAC_API FLAC__bool <a class="code" href="FLAC_2file__encoder_8h.html#a17">FLAC__file_encoder_set_min_residual_partition_order</a>(<a class="code" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, unsigned value);

125

00398

126

00410 FLAC_API FLAC__bool <a class="code" href="FLAC_2file__encoder_8h.html#a18">FLAC__file_encoder_set_max_residual_partition_order</a>(<a class="code" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, unsigned value);

127

00411

128

00423 FLAC_API FLAC__bool <a class="code" href="FLAC_2file__encoder_8h.html#a19">FLAC__file_encoder_set_rice_parameter_search_dist</a>(<a class="code" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, unsigned value);

129

00424

130

00436 FLAC_API FLAC__bool <a class="code" href="FLAC_2file__encoder_8h.html#a20">FLAC__file_encoder_set_total_samples_estimate</a>(<a class="code" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, FLAC__uint64 value);

131

00437

132

00450 FLAC_API FLAC__bool <a class="code" href="FLAC_2file__encoder_8h.html#a21">FLAC__file_encoder_set_metadata</a>(<a class="code" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, <a class="code" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> **metadata, unsigned num_blocks);

133

00451

134

00471 FLAC_API FLAC__bool <a class="code" href="FLAC_2file__encoder_8h.html#a22">FLAC__file_encoder_set_filename</a>(<a class="code" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, const char *value);

135

00472

136

00492 FLAC_API FLAC__bool <a class="code" href="FLAC_2file__encoder_8h.html#a23">FLAC__file_encoder_set_progress_callback</a>(<a class="code" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, <a class="code" href="FLAC_2file__encoder_8h.html#a1">FLAC__FileEncoderProgressCallback</a> value);

137

00493

138

00506 FLAC_API FLAC__bool <a class="code" href="FLAC_2file__encoder_8h.html#a24">FLAC__file_encoder_set_client_data</a>(<a class="code" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, void *value);

139

00507

140

00516 FLAC_API <a class="code" href="FLAC_2file__encoder_8h.html#a52">FLAC__FileEncoderState</a> <a class="code" href="FLAC_2file__encoder_8h.html#a25">FLAC__file_encoder_get_state</a>(const <a class="code" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder);

141

00517

142

00528 FLAC_API <a class="code" href="FLAC_2seekable__stream__encoder_8h.html#a56">FLAC__SeekableStreamEncoderState</a> <a class="code" href="FLAC_2file__encoder_8h.html#a26">FLAC__file_encoder_get_seekable_stream_encoder_state</a>(const <a class="code" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder);

143

00529

144

00541 FLAC_API <a class="code" href="FLAC_2stream__encoder_8h.html#a52">FLAC__StreamEncoderState</a> <a class="code" href="FLAC_2file__encoder_8h.html#a27">FLAC__file_encoder_get_stream_encoder_state</a>(const <a class="code" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder);

145

00542

146

00555 FLAC_API <a class="code" href="FLAC_2stream__decoder_8h.html#a36">FLAC__StreamDecoderState</a> <a class="code" href="FLAC_2file__encoder_8h.html#a28">FLAC__file_encoder_get_verify_decoder_state</a>(const <a class="code" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder);

147

00556

148

00568 FLAC_API const char *<a class="code" href="FLAC_2file__encoder_8h.html#a29">FLAC__file_encoder_get_resolved_state_string</a>(const <a class="code" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder);

149

00569

150

00590 FLAC_API void <a class="code" href="FLAC_2file__encoder_8h.html#a30">FLAC__file_encoder_get_verify_decoder_error_stats</a>(const <a class="code" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, FLAC__uint64 *absolute_sample, unsigned *frame_number, unsigned *channel, unsigned *sample, FLAC__int32 *expected, FLAC__int32 *got);

151

00591

152

00602 FLAC_API FLAC__bool <a class="code" href="FLAC_2file__encoder_8h.html#a31">FLAC__file_encoder_get_verify</a>(const <a class="code" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder);

153

00603

154

00614 FLAC_API FLAC__bool <a class="code" href="FLAC_2file__encoder_8h.html#a32">FLAC__file_encoder_get_streamable_subset</a>(const <a class="code" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder);

155

00615

156

00626 FLAC_API FLAC__bool <a class="code" href="FLAC_2file__encoder_8h.html#a33">FLAC__file_encoder_get_do_mid_side_stereo</a>(const <a class="code" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder);

157

00627

158

00638 FLAC_API FLAC__bool <a class="code" href="FLAC_2file__encoder_8h.html#a34">FLAC__file_encoder_get_loose_mid_side_stereo</a>(const <a class="code" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder);

159

00639

160

00650 FLAC_API unsigned <a class="code" href="FLAC_2file__encoder_8h.html#a35">FLAC__file_encoder_get_channels</a>(const <a class="code" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder);

161

00651

162

00662 FLAC_API unsigned <a class="code" href="FLAC_2file__encoder_8h.html#a36">FLAC__file_encoder_get_bits_per_sample</a>(const <a class="code" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder);

163

00663

164

00674 FLAC_API unsigned <a class="code" href="FLAC_2file__encoder_8h.html#a37">FLAC__file_encoder_get_sample_rate</a>(const <a class="code" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder);

165

00675

166

00686 FLAC_API unsigned <a class="code" href="FLAC_2file__encoder_8h.html#a38">FLAC__file_encoder_get_blocksize</a>(const <a class="code" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder);

167

00687

168

00698 FLAC_API unsigned <a class="code" href="FLAC_2file__encoder_8h.html#a39">FLAC__file_encoder_get_max_lpc_order</a>(const <a class="code" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder);

169

00699

170

00710 FLAC_API unsigned <a class="code" href="FLAC_2file__encoder_8h.html#a40">FLAC__file_encoder_get_qlp_coeff_precision</a>(const <a class="code" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder);

171

00711

172

00722 FLAC_API FLAC__bool <a class="code" href="FLAC_2file__encoder_8h.html#a41">FLAC__file_encoder_get_do_qlp_coeff_prec_search</a>(const <a class="code" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder);

173

00723

174

00734 FLAC_API FLAC__bool <a class="code" href="FLAC_2file__encoder_8h.html#a42">FLAC__file_encoder_get_do_escape_coding</a>(const <a class="code" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder);

175

00735

176

00746 FLAC_API FLAC__bool <a class="code" href="FLAC_2file__encoder_8h.html#a43">FLAC__file_encoder_get_do_exhaustive_model_search</a>(const <a class="code" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder);

177

00747

178

00758 FLAC_API unsigned <a class="code" href="FLAC_2file__encoder_8h.html#a44">FLAC__file_encoder_get_min_residual_partition_order</a>(const <a class="code" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder);

179

00759

180

00770 FLAC_API unsigned <a class="code" href="FLAC_2file__encoder_8h.html#a45">FLAC__file_encoder_get_max_residual_partition_order</a>(const <a class="code" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder);

181

00771

182

00782 FLAC_API unsigned <a class="code" href="FLAC_2file__encoder_8h.html#a46">FLAC__file_encoder_get_rice_parameter_search_dist</a>(const <a class="code" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder);

183

00783

184

00794 FLAC_API FLAC__uint64 <a class="code" href="FLAC_2file__encoder_8h.html#a47">FLAC__file_encoder_get_total_samples_estimate</a>(const <a class="code" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder);

185

00795

186

00810 FLAC_API <a class="code" href="FLAC_2file__encoder_8h.html#a52">FLAC__FileEncoderState</a> <a class="code" href="FLAC_2file__encoder_8h.html#a48">FLAC__file_encoder_init</a>(<a class="code" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder);

187

00811

188

00826 FLAC_API void <a class="code" href="FLAC_2file__encoder_8h.html#a49">FLAC__file_encoder_finish</a>(<a class="code" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder);

189

00827

190

00843 FLAC_API FLAC__bool <a class="code" href="FLAC_2file__encoder_8h.html#a50">FLAC__file_encoder_process</a>(<a class="code" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, const FLAC__int32 * const buffer[], unsigned samples);

191

00844

192

00863 FLAC_API FLAC__bool <a class="code" href="FLAC_2file__encoder_8h.html#a51">FLAC__file_encoder_process_interleaved</a>(<a class="code" href="structFLAC____FileEncoder.html">FLAC__FileEncoder</a> *encoder, const FLAC__int32 buffer[], unsigned samples);

193

00864

194

00865 /* \} */

195

00866

196

00867 #ifdef __cplusplus

197

00868 }

198

00869 #endif

199

00870

200

00871 #endif

201

</pre></div><hr><address>Generated on Fri Feb 4 18:39:10 2005 for FLAC by

202

203

<img src="doxygen.gif" alt="doxygen" align="middle" border=0

204

width=110 height=53></a>1.2.14 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>,

205

206

</body>

207

</html>

Older »